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

#argumentsarray of OCI8::Metadata::Argument

Returns argument information of the type method.

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

Returns:


1129
1130
1131
# File 'lib/oci8/metadata.rb', line 1129

def arguments
  @arguments ||= list_arguments.to_a
end

#encapsulationObject

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


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

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)

1055
1056
1057
# File 'lib/oci8/metadata.rb', line 1055

def has_result?
  __boolean(OCI_ATTR_HAS_RESULT)
end

#inspectObject

:nodoc:


1133
1134
1135
# File 'lib/oci8/metadata.rb', line 1133

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

#is_constructor?Boolean

indicates method is a constructor

Returns:

  • (Boolean)

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

def is_constructor?
  __boolean(OCI_ATTR_IS_CONSTRUCTOR)
end

#is_destructor?Boolean

indicates method is a destructor

Returns:

  • (Boolean)

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

def is_destructor?
  __boolean(OCI_ATTR_IS_DESTRUCTOR)
end

#is_final_method?Boolean

indicates this is a final method

Returns:

  • (Boolean)

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

def is_final_method?
  __boolean(OCI_ATTR_IS_FINAL_METHOD)
end

#is_instantiable_method?Boolean

indicates this is an instantiable method

Returns:

  • (Boolean)

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

def is_instantiable_method?
  __boolean(OCI_ATTR_IS_INSTANTIABLE_METHOD)
end

#is_map?Boolean

indicates method is a map method

Returns:

  • (Boolean)

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

def is_map?
  __boolean(OCI_ATTR_IS_MAP)
end

#is_operator?Boolean

indicates method is an operator

Returns:

  • (Boolean)

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

def is_operator?
  __boolean(OCI_ATTR_IS_OPERATOR)
end

#is_order?Boolean

Indicates method is an order method

Returns:

  • (Boolean)

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

def is_order?
  __boolean(OCI_ATTR_IS_ORDER)
end

#is_overriding_method?Boolean

indicates this is an overriding method

Returns:

  • (Boolean)

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

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)

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

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)

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

def is_rnps?
  __boolean(OCI_ATTR_IS_RNPS)
end

#is_selfish?Boolean

indicates method is selfish

Returns:

  • (Boolean)

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

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)

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

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)

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

def is_wnps?
  __boolean(OCI_ATTR_IS_WNPS)
end

#nameObject

Name of method (procedure or function)


1035
1036
1037
# File 'lib/oci8/metadata.rb', line 1035

def name
  attr_get_string(OCI_ATTR_NAME)
end