This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).

%DeepSee.Session

class %DeepSee.Session extends %Library.RegisteredObject

This class provides the API for DeepSee sessions. An instance of this class represents the current session.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property sessionId as %String;
Id for this session.
Property methods: sessionIdDisplayToLogical(), sessionIdGet(), sessionIdIsValid(), sessionIdLogicalToDisplay(), sessionIdLogicalToOdbc(), sessionIdNormalize(), sessionIdSet()

Methods

classmethod %CreateSession(pSessionId As %String = "", Output pSC As %Status) as Session
Create a new DeepSee session. If pSessionId is provided, then it used, otherwise $J is used.
method %EndSession() as %Status
Terminate this DeepSee session and remove all definitions associated with it.
method %GetSessionId() as %Status
Get the session ID for this session.
private method %OnClose() as %Status
Inherited description: This callback method is invoked by the %Close() method to provide notification that the current object is being closed.

The return value of this method is ignored.

private method %OnNew() as %Status
Inherited description: This callback method is invoked by the %New() 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.

classmethod %ResumeSession(pSessionId As %String = "", Output pSC As %Status) as Session
Resume a previously running session.
method %SuspendSession() as %Status
Suspend the currently running session.

Inherited Members

Inherited Methods (Including Private)

Feedback