Interface ProcessProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, ProcessProfile, Sourceable

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

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface ProcessProfile

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

Modifier and Type	Method	Description
TypeList	getProcessRecordTypes()	Gets all the process record types supported.
TypeList	getProcessSearchRecordTypes()	Gets all the process search record types supported.
TypeList	getStateRecordTypes()	Gets all the state record types supported.
TypeList	getStateSearchRecordTypes()	Gets all the state search record types supported.
boolean	supportsProcessAdmin()	Tests if process administration is supported.
boolean	supportsProcessHierarchy()	Tests if a process hierarchy traversal is supported.
boolean	supportsProcessHierarchyDesign()	Tests if a process hierarchy design is supported.
boolean	supportsProcessLookup()	Tests if process lookup is supported.
boolean	supportsProcessNotification()	Tests if process notification is supported.
boolean	supportsProcessQuery()	Tests if process query is supported.
boolean	supportsProcessRecordType(Type processRecordType)	Tests if a given process record type is supported.
boolean	supportsProcessSearch()	Tests if process search is supported.
boolean	supportsProcessSearchRecordType(Type processSearchRecordType)	Tests if a given process search record type is supported.
boolean	supportsState()	Tests if retrieving mappings of state and Ids is supported.
boolean	supportsStateAdmin()	Tests if state administration is supported.
boolean	supportsStateAssignment()	Tests if managing mappings of states and Ids is supported.
boolean	supportsStateChangeNotification()	Tests if subscirbing to state change notifications is supported.
boolean	supportsStateLookup()	Tests if state lookup is supported.
boolean	supportsStateNotification()	Tests if state notification is supported.
boolean	supportsStateQuery()	Tests if state query is supported.
boolean	supportsStateRecordType(Type stateRecordType)	Tests if a given state record type is supported.
boolean	supportsStateSearch()	Tests if state search is supported.
boolean	supportsStateSearchRecordType(Type stateSearchRecordType)	Tests if a given state search type is supported.
boolean	supportsStateSequencing()	Tests if state sequencing is supported.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getStateSession

StateSession getStateSession(Proxy proxy)
                      throws OperationFailedException

Gets the OsidSession associated with the state service.

Parameters:

proxy - a proxy

Returns:

a StateLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsState() is false

Compliance:

optional - This method must be implemented if {@code supportsState()} is {@code true} .

getStateSessionForProcess

StateSession getStateSessionForProcess(Id processId,
 Proxy proxy)
                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the state service for the given process.

Parameters:

processId - the Id of the process

proxy - a proxy

Returns:

a StateStateSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsState() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsState()} and {@code supportsVisibleFederation()} are {@code true} .

getStateAssignmentSession

StateAssignmentSession getStateAssignmentSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the state assignment service.

Parameters:

proxy - a proxy

Returns:

a StateAssignmentLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsStateAssignment()} is {@code true} .

getStateAssignmentSessionForProcess

StateAssignmentSession getStateAssignmentSessionForProcess(Id processId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the state assignment service for the given process.

Parameters:

processId - the Id of the process

proxy - a proxy

Returns:

a StateAssignmentStateSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateAssignment() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStateAssignment()} and {@code supportsVisibleFederation()} are {@code true} .

getStateChangeNotificationSession

StateNotificationSession getStateChangeNotificationSession(StateChangeReceiver stateChangeReceiver,
 Proxy proxy)
                                                    throws OperationFailedException

Gets the notification session for notifications pertaining to state changes.

Parameters:

stateChangeReceiver - the notification callback

proxy - a proxy

Returns:

a StateChangeNotificationSession

Throws:

NullArgumentException - stateChangeReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateChangeNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsStateChangeNotification()} is {@code true} .

getStateChangeNotificationSessionForProcess

StateNotificationSession getStateChangeNotificationSessionForProcess(StateChangeReceiver stateChangeReceiver,
 Id processId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

Gets the state change notification session for the given process.

Parameters:

stateChangeReceiver - the notification callback

processId - the Id of the process

proxy - a proxy

Returns:

a StateChangeNotificationSession

Throws:

NotFoundException - processId not found

NullArgumentException - stateChangeReceiver, processId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateChangeNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStateChangeNotfication()} and {@code supportsVisibleFederation()} are {@code true} .

getStateLookupSession

StateLookupSession getStateLookupSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the state lookup service.

Parameters:

proxy - a proxy

Returns:

a StateLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStateLookup()} is {@code true} .

getStateLookupSessionForProcess

StateLookupSession getStateLookupSessionForProcess(Id processId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the state lookup service for the given process.

Parameters:

processId - the Id of the process

proxy - a proxy

Returns:

a StateLookupSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStateLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStateQuerySession

StateQuerySession getStateQuerySession(Proxy proxy)
                                throws OperationFailedException

Gets a state query session.

Parameters:

proxy - a proxy

Returns:

a StateQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsStateQuery()} is {@code true} .

getStateQuerySessionForProcess

StateQuerySession getStateQuerySessionForProcess(Id processId,
 Proxy proxy)
                                          throws NotFoundException,
OperationFailedException

Gets a state query session for the given process.

Parameters:

processId - the Id of the process

proxy - a proxy

Returns:

a StateQuerySession

Throws:

NotFoundException - processId not found

NullArgumentException - processId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStateQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getStateSearchSession

StateSearchSession getStateSearchSession(Proxy proxy)
                                  throws OperationFailedException

Gets a state search session.

Parameters:

proxy - a proxy

Returns:

a StateSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsStateSearch()} is {@code true} .

getStateSearchSessionForProcess

StateSearchSession getStateSearchSessionForProcess(Id processId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets a state search session for the given process.

Parameters:

processId - the Id of the process

proxy - a proxy

Returns:

a StateSearchSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStateSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getStateAdminSession

StateAdminSession getStateAdminSession(Proxy proxy)
                                throws OperationFailedException

Gets a state administration session for creating, updating and deleting states.

Parameters:

proxy - a proxy

Returns:

a StateAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsStateAdmin()} is {@code true} .

getStateAdminSessionForProcess

StateAdminSession getStateAdminSessionForProcess(Id processId,
 Proxy proxy)
                                          throws NotFoundException,
OperationFailedException

Gets a state administration session for the given process.

Parameters:

processId - the Id of the process

proxy - a proxy

Returns:

a StateAdminSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStateAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getStateSequencingSession

StateSequencingSession getStateSequencingSession(Proxy proxy)
                                          throws OperationFailedException

Gets a state sequencing session for ordering states.

Parameters:

proxy - a proxy

Returns:

a StateSequencingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateSequencing() is false

Compliance:

optional - This method must be implemented if {@code supportsStateSequencing()} is {@code true} .

getStateSequencingSessionForProcess

StateSequencingSession getStateSequencingSessionForProcess(Id processId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

Gets a state sequencing session for the given process.

Parameters:

processId - the Id of the process

proxy - a proxy

Returns:

a StateSequencingSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateSequencing() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStateSequencing()} and {@code supportsVisibleFederation()} are {@code true} .

getStateNotificationSession

StateNotificationSession getStateNotificationSession(StateReceiver stateReceiver,
 Proxy proxy)
                                              throws OperationFailedException

Gets the state notification session for the given process.

Parameters:

stateReceiver - notification callback

proxy - a proxy

Returns:

a StateNotificationSession

Throws:

NullArgumentException - stateReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsStateNotification()} is {@code true} .

getStateNotificationSessionForProcess

StateNotificationSession getStateNotificationSessionForProcess(StateReceiver stateReceiver,
 Id processId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the state notification session for the given process.

Parameters:

stateReceiver - notification callback

processId - the Id of the process

proxy - a proxy

Returns:

a StateNotificationSession

Throws:

NotFoundException - processId not found

NullArgumentException - stateReceiver, processId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStateNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStateNotfication()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessLookupSession

ProcessLookupSession getProcessLookupSession(Proxy proxy)
                                      throws OperationFailedException

Gets the process lookup session.

Parameters:

proxy - a proxy

Returns:

a ProcessLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessLookup()} is {@code true} .

getProcessQuerySession

ProcessQuerySession getProcessQuerySession(Proxy proxy)
                                    throws OperationFailedException

Gets the process query session.

Parameters:

proxy - a proxy

Returns:

a ProcessQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessQuery()} is {@code true} .

getProcessSearchSession

ProcessSearchSession getProcessSearchSession(Proxy proxy)
                                      throws OperationFailedException

Gets the process search session.

Parameters:

proxy - a proxy

Returns:

a ProcessSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessSearch()} is {@code true} .

getProcessAdminSession

ProcessAdminSession getProcessAdminSession(Proxy proxy)
                                    throws OperationFailedException

Gets the process administrative session for creating, updating and deleteing processes.

Parameters:

proxy - a proxy

Returns:

a ProcessAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessAdmin()} is {@code true} .

getProcessNotificationSession

ProcessNotificationSession getProcessNotificationSession(ProcessReceiver processReceiver,
 Proxy proxy)
                                                  throws OperationFailedException

Gets the notification session for subscriprocessg to changes to a process.

Parameters:

processReceiver - notification callback

proxy - a proxy

Returns:

a ProcessNotificationSession

Throws:

NullArgumentException - processReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessNotification()} is {@code true} .

getProcessHierarchySession

ProcessHierarchySession getProcessHierarchySession(Proxy proxy)
                                            throws OperationFailedException

Gets the process hierarchy traversal session.

Parameters:

proxy - a proxy

Returns:

a ProcessHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessHierarchy()} is {@code true} .

getProcessHierarchyDesignSession

ProcessHierarchyDesignSession getProcessHierarchyDesignSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the process hierarchy design session.

Parameters:

proxy - a proxy

Returns:

a ProcessHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessHierarchyDesign()} is {@code true} .