Skip navigation links

com.sigmadynamics.sdo.interfaces
Interface SessionInterface

All Superinterfaces:

EntityInterface, SDOInterface

All Known Implementing Classes:

SDSessionBase, SessionBase

public interface SessionInterface

extends EntityInterface

Classes of this interface are used to interact with a Session in the context of an integration point call. If no session key value is present, then a Temporary Session will be provided that lasts only for the duration of the call. It is assumed that Sessions are single threaded and physically located in only one JVM.

Since:

1.0

Method Summary

void	cleanUp()
void	close()
ApplicationInterface	getApp()
ChoiceHistoryInterface	getChoiceHistory()
java.util.Set	getKeys()
long	getTimeToDie() Get the session's idle timer value.
void	init()
boolean	isBatchSession()
boolean	isClosed()
boolean	isClosing()
boolean	isTemporary()
boolean	isTimedOut()

Methods inherited from interface com.sigmadynamics.sdo.interfaces.EntityInterface

fill, reset, resetAttributes

Methods inherited from interface com.sigmadynamics.sdo.interfaces.client.SDOInterface

getDescription, getSDOId, getSDOLabel, getSDOLabelOrId

Method Detail

isTemporary

boolean isTemporary()

Returns:

true if the session has no keys and will live only for the duration of the current request.

isTimedOut

boolean isTimedOut()

Returns:

true if the session has not received any recent requests and was closed, or will close, as a consequence.

getTimeToDie

long getTimeToDie()

Get the session's idle timer value.

Returns:

Millisec remaining before this session is subject to being discarded.

isClosed

boolean isClosed()

Returns:

true if the session has finished closing.

isClosing

boolean isClosing()

Returns:

true if the session is in the process of closing.

getKeys

java.util.Set getKeys()

init

void init()

cleanUp

void cleanUp()

close

void close()

getApp

ApplicationInterface getApp()

getChoiceHistory

ChoiceHistoryInterface getChoiceHistory()

isBatchSession

boolean isBatchSession()

Skip navigation links