DOFObjectProvidersession Method OpenDOF Object Access Library
A new session is requested.

Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax

C#
void session(
	DOFOperationProvide operation,
	DOFRequestSession request,
	DOFObject object_Renamed,
	DOFInterfaceID interfaceID,
	DOFObjectID sessionID,
	DOFInterfaceID sessionType
)

Parameters

operation
Type: org.opendof.core.oalDOFOperationProvide
Information about the corresponding provide operation. This will never be null.
request
Type: org.opendof.core.oalDOFRequestSession
Information about the request. This will never be null. Use this to Use this to return, indicating that the Session has been initiated (use
request.respond()
) or to throw exceptions (use
request.respond(...)
).

DOFProviderException should be thrown for any error condition that is defined as an exception in the DOFInterface.

DOFErrorException should be thrown for any error condition that falls outside of the exceptions defined in the DOFInterface.

object_Renamed
Type: org.opendof.core.oalDOFObject
The object the session is being requested on. This will never be null.
interfaceID
Type: org.opendof.core.oalDOFInterfaceID
Any interfaceID that the specific provider must be currently providing in order to receive this request. This will never be null.
sessionID
Type: org.opendof.core.oalDOFObjectID
The session object identifier. This uniquely identifies the session and includes a Session Attribute chosen by the requestor. A DOFObject may be created directly from this id to provide interfaces on the session. This will never be null.
sessionType
Type: org.opendof.core.oalDOFInterfaceID
The requested session type (a DOFInterfaceID ), defining the purpose and contract for the session. This interface should typically be provided on the session (possibly in addition to others), but no specific behavior is required. This will never be null.
Remarks

A new session is requested.

NOTE: You MUST call one of the Session.respond() methods when you have finished processing the request. The request is kept in a "pending" status until one of these calls is made. This means that you may spawn a thread which could finish processing this request after returning from this method.

See Also

Reference

Session.respond(DOFErrorException)