API Reference

procedure Begin_Session

   procedure Begin_Session(  
      This : in out Object; 
      Name : in String ); 
 

Description

Begin a session which is connected to the given object space.

Preconditions

None

Postconditions

Session is active

Exceptions

None

procedure End_Session

   procedure End_Session(  
      This : in out Object ); 
 

Description

End a session. All objects which are member of a transaction which has not been committed yet are lost.

Preconditions

Session is active

Postconditions

Is_Sesstion_Active = False

Exceptions

None

procedure Set_Current_Session

   procedure Set_Current_Session(  
      Ses : in Handle ); 
 

Description

Set the current session handle for the current thread.

Preconditions

None

Postconditions

The current thread referres to the give session handle.

Exceptions

Notes:

function Current_Session

   function Current_Session return Handle;  
 

Description

Return the current session handle

Preconditions

Session is active

Postconditions

Exceptions:

Wrong_Session_State

function Connection, function Connection

   function Connection(  
      H : Handle ) return Service.Client.Handle; 
 
   function Connection( 
      H : in Handle ) return Service.Client.Object; 
 

Description

Get the handle of the connection object.

Preconditions

Session is active

Postconditions

none

Exceptions

Wrong_Session_State

procedure Get_Object

   procedure Get_Object(  
      Obj    : in out Persistent.Object'Class; 
      Name   : in String    := ""; 
      Id     : in Object_ID := Null_Object_ID; 
      Create : in Boolean   := True ); 
 

Description

Get the object from the object space. If it does not exist create a new object. The object can be selected either by the object id or the name. If the name does not exist a new root name entry will be created.

Preconditions

Postconditions:

Exceptions

Notes:

procedure Delete_Object

   procedure Delete_Object(  
      Obj  : in out Persistent.Object'Class; 
      Name : in String := "" ); 
 

Description

Delete the object from the object space assgined to the current session. If the parameter Name is not given, the object is identified by the object identifier, otherwise the name is looked up in the root name table of the object space.

Preconditions

P.1 - Session is active

P.2 - Object identifier is set or Name given

Postconditions

Exceptions:

function Rootname

   function Rootname(   
      Name : in String ) return Object_ID; 
       

Description

Preconditions:

Postconditions

Exceptions:

function Image

   function Image(   
      Ses  : in Handle ) return String; 
  
   Wrong_Session_State : exception; 
   Not_Assigned        : exception; 
   Invalid_Parameters  : exception; 
   Object_Not_Found    : exception; 
 

Description

Provide an string which represents the handle by returning the data base space connected. If the handle is not valid (null) the string undefined is returned.

Preconditions

none

Postconditions

none

Exceptions

none

Notes

none