NAME

       corba_object - The CORBA Object interface functions

DESCRIPTION

       This  module  contains  the  CORBA  Object  interface functions that can be called for all
       objects.

EXPORTS

       get_interface(Object) -> InterfaceDef

              Types:

                 Object = #objref
                 InterfaceDef = term()

              This function returns the full interface description for an object.

       is_nil(Object) -> boolean()

              Types:

                 Object = #objref

              This function checks if the object reference has a nil object value, which  denotes
              no  object.  It  is  the  reference  that is tested and no object implementation is
              involved in the test.

       is_a(Object, Logical_type_id) -> Return
       is_a(Object, Logical_type_id, Contexts) -> Return

              Types:

                 Object = #objref
                 Logical_type_id = string()
                 Contexts = [Context]
                 Context = #'IOP_ServiceContext'{context_id = CtxId, context_data = CtxData}
                 CtxId = ?ORBER_GENERIC_CTX_ID
                 CtxData = {interface, Interface}  |  {userspecific,  term()}  |  {configuration,
                 Options}
                 Interface = string()
                 Options = [{Key, Value}]
                 Key = ssl_client_options
                 Value = allowed value associated with the given key
                 Return = boolean() | {'EXCEPTION', E}

              The  Logical_type_id  is  a string that is a share type identifier (repository id).
              The function returns true if the object is an instance of that type or an  ancestor
              of the "most derived" type of that object.

              The  configuration  context  is  used  to  override  the  global  SSL  client  side
              configuration.

              Note: Other ORB suppliers may not support this function completely according to the
              OMG   specification.   Thus,  a  is_a  call  may  raise  an  exception  or  respond
              unpredictable if the Object is located on a remote node.

       is_remote(Object) -> boolean()

              Types:

                 Object = #objref

              This function returns true if an object reference is remote otherwise false.

       non_existent(Object) -> Return
       non_existent(Object, Contexts) -> Return

              Types:

                 Object = #objref
                 Contexts = [Context]
                 Context = #'IOP_ServiceContext'{context_id = CtxId, context_data = CtxData}
                 CtxId = ?ORBER_GENERIC_CTX_ID
                 CtxData = {interface, Interface}  |  {userspecific,  term()}  |  {configuration,
                 Options}
                 Interface = string()
                 Options = [{Key, Value}]
                 Key = ssl_client_options
                 Value = allowed value associated with the given key
                 Return = boolean() | {'EXCEPTION', E}

              This  function  can  be used to test if the object has been destroyed. It does this
              without invoking any application level code. The ORB returns true if it knows  that
              the object is destroyed otherwise false.

              The  configuration  context  is  used  to  override  the  global  SSL  client  side
              configuration.

              Note: The OMG have specified two different operators, _not_existent (CORBA  version
              2.0  and  2.2) and _non_existent (CORBA version 2.3), to be used for this function.
              It is not mandatory to support both versions. Thus, a non_existent call  may  raise
              an  exception  or  respond unpredictable if the Object is located on a remote node.
              Depending on which version, ORB:s you intend to communicate with supports, you  can
              either use this function or not_existent/1.

       not_existent(Object) -> Return
       not_existent(Object, Contexts) -> Return

              Types:

                 Object = #objref
                 Contexts = [Context]
                 Context = #'IOP_ServiceContext'{context_id = CtxId, context_data = CtxData}
                 CtxId = ?ORBER_GENERIC_CTX_ID
                 CtxData  =  {interface,  Interface}  |  {userspecific, term()} | {configuration,
                 Options}
                 Interface = string()
                 Options = [{Key, Value}]
                 Key = ssl_client_options
                 Value = allowed value associated with the given key
                 Return = boolean() | {'EXCEPTION', E}

              This function is implemented due to Interoperable purposes. Behaves as non_existent
              except the operator _not_existent is used when communicating with other ORB:s.

              The  configuration  context  is  used  to  override  the  global  SSL  client  side
              configuration.

       is_equivalent(Object, OtherObject) -> boolean()

              Types:

                 Object = #objref
                 OtherObject = #objref

              This function is used to determine if two object references are equivalent  so  far
              the  ORB  easily  can  determine. It returns true if the target object reference is
              equal to the other object reference and false otherwise.

       hash(Object, Maximum) -> int()

              Types:

                 Object = #objref
                 Maximum = int()

              This function returns a hash value based on the  object  reference  that  not  will
              change  during  the lifetime of the object. The Maximum parameter denotes the upper
              bound of the value.