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_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:



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

def arguments
  @arguments ||= list_arguments.to_a
end

#encapsulationObject

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



998
999
1000
1001
1002
1003
# File 'lib/oci8/metadata.rb', line 998

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)


1012
1013
1014
# File 'lib/oci8/metadata.rb', line 1012

def has_result?
  __boolean(OCI_ATTR_HAS_RESULT)
end

#inspectObject

:nodoc:



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

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

#is_constructor?Boolean

indicates method is a constructor

Returns:

  • (Boolean)


1017
1018
1019
# File 'lib/oci8/metadata.rb', line 1017

def is_constructor?
  __boolean(OCI_ATTR_IS_CONSTRUCTOR)
end

#is_destructor?Boolean

indicates method is a destructor

Returns:

  • (Boolean)


1022
1023
1024
# File 'lib/oci8/metadata.rb', line 1022

def is_destructor?
  __boolean(OCI_ATTR_IS_DESTRUCTOR)
end

#is_final_method?Boolean

indicates this is a final method

Returns:

  • (Boolean)


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

def is_final_method?
  __boolean(OCI_ATTR_IS_FINAL_METHOD)
end

#is_instantiable_method?Boolean

indicates this is an instantiable method

Returns:

  • (Boolean)


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

def is_instantiable_method?
  __boolean(OCI_ATTR_IS_INSTANTIABLE_METHOD)
end

#is_map?Boolean

indicates method is a map method

Returns:

  • (Boolean)


1037
1038
1039
# File 'lib/oci8/metadata.rb', line 1037

def is_map?
  __boolean(OCI_ATTR_IS_MAP)
end

#is_operator?Boolean

indicates method is an operator

Returns:

  • (Boolean)


1027
1028
1029
# File 'lib/oci8/metadata.rb', line 1027

def is_operator?
  __boolean(OCI_ATTR_IS_OPERATOR)
end

#is_order?Boolean

Indicates method is an order method

Returns:

  • (Boolean)


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

def is_order?
  __boolean(OCI_ATTR_IS_ORDER)
end

#is_overriding_method?Boolean

indicates this is an overriding method

Returns:

  • (Boolean)


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

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)


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

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)


1052
1053
1054
# File 'lib/oci8/metadata.rb', line 1052

def is_rnps?
  __boolean(OCI_ATTR_IS_RNPS)
end

#is_selfish?Boolean

indicates method is selfish

Returns:

  • (Boolean)


1032
1033
1034
# File 'lib/oci8/metadata.rb', line 1032

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)


1057
1058
1059
# File 'lib/oci8/metadata.rb', line 1057

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)


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

def is_wnps?
  __boolean(OCI_ATTR_IS_WNPS)
end

#nameObject

Name of method (procedure or function)



992
993
994
# File 'lib/oci8/metadata.rb', line 992

def name
  attr_get_string(OCI_ATTR_NAME)
end