public interface SimpleSessionContext extends java.io.Serializable, UserAttributeContainer
ExecutableComponent. Therefore the session context is
serialisable but does not provide any service logic but mere data.| Modifier and Type | Field and Description |
|---|---|
static long |
serialVersionUID
Generated ID for serialisation.
|
| Modifier and Type | Method and Description |
|---|---|
ActivityInstance |
getActivityInstance()
Gets the activity instance of an execution, that is the complete process
context, for instance the configuration of the activity in the process.
|
Enquiry |
getCurrentEnquiry()
Gets the current enquiry that was caused when executing.
|
SerialisableDataContext |
getDataContext()
Gets the data context, that is, an interface to get and set the
values of all input and output parameters of an execution.
|
EBPInstanceReference |
getEBPInstanceReference()
Returns the reference to the corresponding process step which contains all
information to identify the process step.
|
Enquiry |
getRepliedEnquiry()
Gets the replied enquiry in case the execution has an enquiry (by the
current user) and this has been replied now.
|
java.lang.String |
getSavepoint()
Gets the savepoint at which the execution is to be resumed if it is to be
resumed at all.
|
java.lang.String |
getSessionID()
Returns the the session id that makes possible to identify the
execution the session context belongs to.
|
boolean |
isResumed()
Gets whether this session context is for resuming an activity (or a normal
start).
|
boolean |
isTestMode()
Gets whether the execution is test mode.
|
boolean |
isViewOnly()
Gets whether the execution is in view only mode, that is, the values of the
input and output parameters are just displayed but can not be changed.
|
getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValuestatic final long serialVersionUID
java.lang.String getSessionID()
SessionContext.getSessionID()boolean isResumed()
ExecutableComponent.initResume(String, SessionContext)java.lang.String getSavepoint()
null).null for normal starts and for resuming without an
explicit savepoint.isResumed(),
ExecutableComponent.initResume(String, SessionContext)EBPInstanceReference getEBPInstanceReference()
SessionContext.getEBPInstanceReference()SerialisableDataContext getDataContext()
SessionContext.getDataContext()ActivityInstance getActivityInstance()
boolean isTestMode()
isTestMode() and isViewOnly() are mutual exclusive just
one of this flag is set if any.
SessionContext.isTestMode(),
ExecutionContext,
ProcessConstants.ExecutionModeboolean isViewOnly()
getDataContext() returns a read-only
data context which allows to retrieve the values of output parameters.
isTestMode() and isViewOnly() are mutual exclusive just
one of this flag is set if any. But isViewOnly() can be mixed
together with getCurrentEnquiry() and/or
getRepliedEnquiry() which means that there is an enquiry or a
reply for the execution but it has already been completely finished.
SessionContext.isViewOnly(),
ProcessConstants.ExecutionModeEnquiry getCurrentEnquiry()
If the execution does not have an enquiry, the returned
Enquiry will be null. The reply
will obviously always be null since it has not been replied to yet.
Important: In case there is an enquiry for the current execution it
should not be allowed to be closed but just to be suspended. Otherwise the
agent sending the enquiry will only receive the reply but without the data
the activity! Please note that the enquiry mode can be mixed together
with isViewOnly(), this means, the execution is in view-only mode
and has an open enquiry that needs to be replied.
SessionContext.getCurrentEnquiry(),
ExecutionContext.getCurrentEnquiry()Enquiry getRepliedEnquiry()
If the execution has not been made an enquiry for, the returned
Enquiry will be null.
Unlike getCurrentEnquiry() this enquiry is reply to a previous
enquiry. If there is no current enquiry (getCurrentEnquiry()
returns null), the execution can just be closed. Please note that the
replied enquiry mode can be mixed together with isViewOnly(), this
means, the execution is in view-only mode and has a reply for an enquiry.
SessionContext.getRepliedEnquiry(),
ExecutionContext.getRepliedEnquiry()