Class: OCI8::Metadata::TypeMethod

Inherits:
Base
  • Object
show all
Defined in:
lib/oci8/metadata.rb

Overview

Metadata for a type method.

This is returned by:

  • OCI8::Metadata::Type#type_methods

  • OCI8::Metadata::Type#map_method

  • OCI8::Metadata::Type#order_method

– How can I know whether FUNCTION or PROCEDURE? ++

Instance Method Summary collapse

Methods inherited from Base

#obj_id, #obj_link, #obj_name, #obj_schema

Instance Method Details

#arguments ⇒ array of OCI8::Metadata::Argument

Returns argument information of the type method.

The first element is the return type in case of Function.

Returns:



1135
1136
1137
 
# File 'lib/oci8/metadata.rb', line 1135

def arguments
  @arguments ||= list_arguments.to_a
end

#encapsulation ⇒ Object

encapsulation level of the method. Values are :public or :private.



1047
1048
1049
1050
1051
1052
 
# File 'lib/oci8/metadata.rb', line 1047

def encapsulation
  case attr_get_ub4(OCI_ATTR_ENCAPSULATION)
  when 0; :private
  when 1; :public
  end
end

#has_result? ⇒ Boolean

indicates method is has rsult

Returns:

  • (Boolean) 


1061
1062
1063
 
# File 'lib/oci8/metadata.rb', line 1061

def has_result?
  __boolean(OCI_ATTR_HAS_RESULT)
end

#inspect ⇒ Object

:nodoc:



1139
1140
1141
 
# File 'lib/oci8/metadata.rb', line 1139

def inspect # :nodoc:
  "#<#{self.class.name}: #{name}>"
end

#is_constructor? ⇒ Boolean

indicates method is a constructor

Returns:

  • (Boolean) 


1066
1067
1068
 
# File 'lib/oci8/metadata.rb', line 1066

def is_constructor?
  __boolean(OCI_ATTR_IS_CONSTRUCTOR)
end

#is_destructor? ⇒ Boolean

indicates method is a destructor

Returns:

  • (Boolean) 


1071
1072
1073
 
# File 'lib/oci8/metadata.rb', line 1071

def is_destructor?
  __boolean(OCI_ATTR_IS_DESTRUCTOR)
end

#is_final_method? ⇒ Boolean

indicates this is a final method

Returns:

  • (Boolean) 


1116
1117
1118
 
# File 'lib/oci8/metadata.rb', line 1116

def is_final_method?
  __boolean(OCI_ATTR_IS_FINAL_METHOD)
end

#is_instantiable_method? ⇒ Boolean

indicates this is an instantiable method

Returns:

  • (Boolean) 


1121
1122
1123
 
# File 'lib/oci8/metadata.rb', line 1121

def is_instantiable_method?
  __boolean(OCI_ATTR_IS_INSTANTIABLE_METHOD)
end

#is_map? ⇒ Boolean

indicates method is a map method

Returns:

  • (Boolean) 


1086
1087
1088
 
# File 'lib/oci8/metadata.rb', line 1086

def is_map?
  __boolean(OCI_ATTR_IS_MAP)
end

#is_operator? ⇒ Boolean

indicates method is an operator

Returns:

  • (Boolean) 


1076
1077
1078
 
# File 'lib/oci8/metadata.rb', line 1076

def is_operator?
  __boolean(OCI_ATTR_IS_OPERATOR)
end

#is_order? ⇒ Boolean

Indicates method is an order method

Returns:

  • (Boolean) 


1091
1092
1093
 
# File 'lib/oci8/metadata.rb', line 1091

def is_order?
  __boolean(OCI_ATTR_IS_ORDER)
end

#is_overriding_method? ⇒ Boolean

indicates this is an overriding method

Returns:

  • (Boolean) 


1126
1127
1128
 
# File 'lib/oci8/metadata.rb', line 1126

def is_overriding_method?
  __boolean(OCI_ATTR_IS_OVERRIDING_METHOD)
end

#is_rnds? ⇒ Boolean

indicates “Read No Data State”(does not query database tables) is set.

Returns:

  • (Boolean) 


1096
1097
1098
 
# File 'lib/oci8/metadata.rb', line 1096

def is_rnds?
  __boolean(OCI_ATTR_IS_RNDS)
end

#is_rnps? ⇒ Boolean

Indicates “Read No Package State”(does not reference the values of packaged variables) is set.

Returns:

  • (Boolean) 


1101
1102
1103
 
# File 'lib/oci8/metadata.rb', line 1101

def is_rnps?
  __boolean(OCI_ATTR_IS_RNPS)
end

#is_selfish? ⇒ Boolean

indicates method is selfish

Returns:

  • (Boolean) 


1081
1082
1083
 
# File 'lib/oci8/metadata.rb', line 1081

def is_selfish?
  __boolean(OCI_ATTR_IS_SELFISH)
end

#is_wnds? ⇒ Boolean

indicates “Write No Data State”(does not modify tables) is set.

Returns:

  • (Boolean) 


1106
1107
1108
 
# File 'lib/oci8/metadata.rb', line 1106

def is_wnds?
  __boolean(OCI_ATTR_IS_WNDS)
end

#is_wnps? ⇒ Boolean

indicates “Write No Package State”(does not change the values of packaged variables) is set.

Returns:

  • (Boolean) 


1111
1112
1113
 
# File 'lib/oci8/metadata.rb', line 1111

def is_wnps?
  __boolean(OCI_ATTR_IS_WNPS)
end

#name ⇒ Object

Name of method (procedure or function)



1041
1042
1043
 
# File 'lib/oci8/metadata.rb', line 1041

def name
  attr_get_string(OCI_ATTR_NAME)
end