public interface ProcessProxyManager extends OsidProxyManager, ProcessProfile
The state manager provides access to state lookup and creation session
and provides interoperability tests for various aspects of this service.
Methods in this manager support the passing of a Proxy
for
the purposes of passing information from a server environment. The
sessions included in this manager are:
StateSession:
a session to look up state to
Id
mappings StateAssignmentSession:
a session to manage state
to Id
mappings StateChangeNotificationSession:
a session to
subscribe to state changes StateLookupSession:
a session to retrieve states
StateQuerySession:
a session to query states StateSearchSession:
a session to search for states
StateAdminSession:
a session to create and delete
states StateSequencingSession:
a session to sequence
states StateNotificationSession:
a session to receive
notifications pertaining to state changes ProcessLookupSession: a
session to retrieve
processes ProcessQuerySession:
a session to query processes
ProcessSearchSession:
a session to search for
processes ProcessAdminSession:
a session to create, update
and delete processes ProcessNotificationSession:
a session to receive
notifications pertaining to changes in processes ProcessHierarchySession:
a session to traverse
process hierarchies ProcessHierarchyDesignSession:
a session to manage
process hierarchies Modifier and Type | Method and Description |
---|---|
ProcessAdminSession |
getProcessAdminSession(Proxy proxy)
Gets the process administrative session for creating, updating and
deleteing processes.
|
ProcessHierarchyDesignSession |
getProcessHierarchyDesignSession(Proxy proxy)
Gets the process hierarchy design session.
|
ProcessHierarchySession |
getProcessHierarchySession(Proxy proxy)
Gets the process hierarchy traversal session.
|
ProcessLookupSession |
getProcessLookupSession(Proxy proxy)
Gets the process lookup session.
|
ProcessNotificationSession |
getProcessNotificationSession(ProcessReceiver processReceiver,
Proxy proxy)
Gets the notification session for subscriprocessg to changes to a
process.
|
ProcessQuerySession |
getProcessQuerySession(Proxy proxy)
Gets the process query session.
|
ProcessSearchSession |
getProcessSearchSession(Proxy proxy)
Gets the process search session.
|
StateAdminSession |
getStateAdminSession(Proxy proxy)
Gets a state administration session for creating, updating and
deleting states.
|
StateAdminSession |
getStateAdminSessionForProcess(Id processId,
Proxy proxy)
Gets a state administration session for the given process.
|
StateAssignmentSession |
getStateAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with the state
assignment service. |
StateAssignmentSession |
getStateAssignmentSessionForProcess(Id processId,
Proxy proxy)
Gets the
OsidSession associated with the state
assignment service for the given process. |
StateNotificationSession |
getStateChangeNotificationSession(StateChangeReceiver stateChangeReceiver,
Proxy proxy)
Gets the notification session for notifications pertaining to state
changes.
|
StateNotificationSession |
getStateChangeNotificationSessionForProcess(StateChangeReceiver stateChangeReceiver,
Id processId,
Proxy proxy)
Gets the state change notification session for the given process.
|
StateLookupSession |
getStateLookupSession(Proxy proxy)
Gets the
OsidSession associated with the state lookup
service. |
StateLookupSession |
getStateLookupSessionForProcess(Id processId,
Proxy proxy)
Gets the
OsidSession associated with the state lookup
service for the given process. |
StateNotificationSession |
getStateNotificationSession(StateReceiver stateReceiver,
Proxy proxy)
Gets the state notification session for the given process.
|
StateNotificationSession |
getStateNotificationSessionForProcess(StateReceiver stateReceiver,
Id processId,
Proxy proxy)
Gets the state notification session for the given process.
|
StateQuerySession |
getStateQuerySession(Proxy proxy)
Gets a state query session.
|
StateQuerySession |
getStateQuerySessionForProcess(Id processId,
Proxy proxy)
Gets a state query session for the given process.
|
StateSearchSession |
getStateSearchSession(Proxy proxy)
Gets a state search session.
|
StateSearchSession |
getStateSearchSessionForProcess(Id processId,
Proxy proxy)
Gets a state search session for the given process.
|
StateSequencingSession |
getStateSequencingSession(Proxy proxy)
Gets a state sequencing session for ordering states.
|
StateSequencingSession |
getStateSequencingSessionForProcess(Id processId,
Proxy proxy)
Gets a state sequencing session for the given process.
|
StateSession |
getStateSession(Proxy proxy)
Gets the
OsidSession associated with the state service. |
StateSession |
getStateSessionForProcess(Id processId,
Proxy proxy)
Gets the
OsidSession associated with the state service
for the given process. |
changeBranch, initialize, rollbackService
close
getProcessRecordTypes, getProcessSearchRecordTypes, getStateRecordTypes, getStateSearchRecordTypes, supportsProcessAdmin, supportsProcessHierarchy, supportsProcessHierarchyDesign, supportsProcessLookup, supportsProcessNotification, supportsProcessQuery, supportsProcessRecordType, supportsProcessSearch, supportsProcessSearchRecordType, supportsState, supportsStateAdmin, supportsStateAssignment, supportsStateChangeNotification, supportsStateLookup, supportsStateNotification, supportsStateQuery, supportsStateRecordType, supportsStateSearch, supportsStateSearchRecordType, supportsStateSequencing, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
StateSession getStateSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the state service.proxy
- a proxy a StateLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsState()
is false
optional
- This method must be implemented if
supportsState()
is true.
StateSession getStateSessionForProcess(Id processId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the state service
for the given process.processId
- the Id
of the processproxy
- a proxy a StateStateSession
NotFoundException
- processId
not foundNullArgumentException
- processId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsState()
or supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsState()
and
supportsVisibleFederation()
are true.
StateAssignmentSession getStateAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the state
assignment service.proxy
- a proxy a StateAssignmentLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStateAssignment()
is false
optional
- This method must be implemented if
supportsStateAssignment()
is true.
StateAssignmentSession getStateAssignmentSessionForProcess(Id processId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the state
assignment service for the given process.processId
- the Id
of the processproxy
- a proxy a StateAssignmentStateSession
NotFoundException
- processId
not foundNullArgumentException
- processId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsStateAssignment()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStateAssignment()
and
supportsVisibleFederation()
are true.
StateNotificationSession getStateChangeNotificationSession(StateChangeReceiver stateChangeReceiver, Proxy proxy) throws OperationFailedException
stateChangeReceiver
- the notification callbackproxy
- a proxy a StateChangeNotificationSession
NullArgumentException
- stateChangeReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStateChangeNotification()
is false
optional
- This method must be implemented if
supportsStateChangeNotification()
is true.
StateNotificationSession getStateChangeNotificationSessionForProcess(StateChangeReceiver stateChangeReceiver, Id processId, Proxy proxy) throws NotFoundException, OperationFailedException
stateChangeReceiver
- the notification callbackprocessId
- the Id
of the processproxy
- a proxy a StateChangeNotificationSession
NotFoundException
- processId
not foundNullArgumentException
- stateChangeReceiver,
processId
, or proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsStateChangeNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStateChangeNotfication()
and
supportsVisibleFederation()
are true.
StateLookupSession getStateLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the state lookup
service.proxy
- a proxy a StateLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStateLookup()
is false
optional
- This method must be implemented if
supportsStateLookup()
is true.
StateLookupSession getStateLookupSessionForProcess(Id processId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the state lookup
service for the given process.processId
- the Id
of the processproxy
- a proxy a StateLookupSession
NotFoundException
- processId
not foundNullArgumentException
- processId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsStateLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsStateLookup()
and
supportsVisibleFederation()
are true.
StateQuerySession getStateQuerySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy a StateQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStateQuery()
is false
optional
- This method must be implemented if
supportsStateQuery()
is true.
StateQuerySession getStateQuerySessionForProcess(Id processId, Proxy proxy) throws NotFoundException, OperationFailedException
processId
- the Id
of the processproxy
- a proxy a StateQuerySession
NotFoundException
- processId
not foundNullArgumentException
- processId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsStateQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsStateQuery()
and
supportsVisibleFederation()
are true.
StateSearchSession getStateSearchSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy a StateSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStateSearch()
is false
optional
- This method must be implemented if
supportsStateSearch()
is true.
StateSearchSession getStateSearchSessionForProcess(Id processId, Proxy proxy) throws NotFoundException, OperationFailedException
processId
- the Id
of the processproxy
- a proxy a StateSearchSession
NotFoundException
- processId
not foundNullArgumentException
- processId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsStateSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsStateSearch()
and
supportsVisibleFederation()
are true.
StateAdminSession getStateAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy a StateAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStateAdmin()
is false
optional
- This method must be implemented if
supportsStateAdmin()
is true.
StateAdminSession getStateAdminSessionForProcess(Id processId, Proxy proxy) throws NotFoundException, OperationFailedException
processId
- the Id
of the processproxy
- a proxy a StateAdminSession
NotFoundException
- processId
not foundNullArgumentException
- processId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStateAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsStateAdmin()
and
supportsVisibleFederation()
are true.
StateSequencingSession getStateSequencingSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy a StateSequencingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStateSequencing()
is false
optional
- This method must be implemented if
supportsStateSequencing()
is true.
StateSequencingSession getStateSequencingSessionForProcess(Id processId, Proxy proxy) throws NotFoundException, OperationFailedException
processId
- the Id
of the processproxy
- a proxy a StateSequencingSession
NotFoundException
- processId
not foundNullArgumentException
- processId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStateSequencing()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStateSequencing()
and
supportsVisibleFederation()
are true.
StateNotificationSession getStateNotificationSession(StateReceiver stateReceiver, Proxy proxy) throws OperationFailedException
stateReceiver
- notification callbackproxy
- a proxy a StateNotificationSession
NullArgumentException
- stateReceiver
or
proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsStateNotification()
is false
optional
- This method must be implemented if
supportsStateNotification()
is true.
StateNotificationSession getStateNotificationSessionForProcess(StateReceiver stateReceiver, Id processId, Proxy proxy) throws NotFoundException, OperationFailedException
stateReceiver
- notification callbackprocessId
- the Id
of the processproxy
- a proxy a StateNotificationSession
NotFoundException
- processId
not foundNullArgumentException
- stateReceiver, processId
or proxy
is nullOperationFailedException
- unable to complete
request
UnimplementedException
-
supportsStateNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStateNotfication()
and
supportsVisibleFederation()
are true.
ProcessLookupSession getProcessLookupSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ProcessLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessLookup()
is false
optional
- This method must be implemented if
supportsProcessLookup()
is true.
ProcessQuerySession getProcessQuerySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ProcessQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessQuery()
is false
optional
- This method must be implemented if
supportsProcessQuery()
is true.
ProcessSearchSession getProcessSearchSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ProcessSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessSearch()
is false
optional
- This method must be implemented if
supportsProcessSearch()
is true.
ProcessAdminSession getProcessAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ProcessAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessAdmin()
is false
optional
- This method must be implemented if
supportsProcessAdmin()
is true.
ProcessNotificationSession getProcessNotificationSession(ProcessReceiver processReceiver, Proxy proxy) throws OperationFailedException
processReceiver
- notification callbackproxy
- a proxy ProcessNotificationSession
NullArgumentException
- processReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessNotification()
is false
optional
- This method must be implemented if
supportsProcessNotification()
is true.
ProcessHierarchySession getProcessHierarchySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy a ProcessHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessHierarchy()
is false
optional
- This method must be implemented if
supportsProcessHierarchy()
is true.
ProcessHierarchyDesignSession getProcessHierarchyDesignSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ProcessHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessHierarchyDesign()
is false
optional
- This method must be implemented if
supportsProcessHierarchyDesign()
is true.