Session Class Reference

This class provides the API for DeepSee sessions. More...

Inheritance diagram for Session:

Collaboration diagram for Session:

Public Member Functions
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	sessionId
	Id for this session. More...

Private Member Functions
_.Library.Status	EndSession ()
	Terminate this DeepSee session and remove all definitions. More...
_.Library.Status	GetSessionId ()
	Get the session ID for this session.
_.Library.Status	SuspendSession ()
	Suspend the currently running session.

Static Private Member Functions
_.DeepSee.Session	CreateSession (_.Library.String pSessionId, _.Library.Status pSC)
	Create a new DeepSee session. More...
_.DeepSee.Session	ResumeSession (_.Library.String pSessionId, _.Library.Status pSC)
	Resume a previously running session.

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

This class provides the API for DeepSee sessions.

An instance of this class represents the current session.

Member Function Documentation

CreateSession()

_.DeepSee.Session CreateSession ( _.Library.String  pSessionId, _.Library.Status  pSC  )

staticprivate

Create a new DeepSee session.

If pSessionId is provided, then it used, otherwise $J is used.

EndSession()

_.Library.Status EndSession ( )

private

Terminate this DeepSee session and remove all definitions.

associated with it.

OnClose()

_.Library.Status OnClose

(

)

This callback method is invoked by the <METHOD>Close</METHOD> method to.

provide notification that the current object is being closed.

The return value of this method is ignored.

Reimplemented from RegisteredObject.

OnNew()

_.Library.Status OnNew

(

)

This callback method is invoked by the <METHOD>New</METHOD> method to.

provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from New(). For example, if you're going to call New, passing 2 arguments, OnNew's signature could be:

Method OnNew(dob as Date = "", name as Name = "") as Status If instead of returning a Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of New method.

Reimplemented from RegisteredObject.

Member Data Documentation

sessionId

sessionId

Id for this session.