org.osid.process

Interface ProcessProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, 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

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.process.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsState() is 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 supportsState() and supportsVisibleFederation() are 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 supportsStateAssignment() is 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 supportsStateAssignment() and supportsVisibleFederation() are 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 supportsStateChangeNotification() is 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 supportsStateChangeNotfication() and supportsVisibleFederation() are 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 supportsStateLookup() is 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 supportsStateLookup() and supportsVisibleFederation() are 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 supportsStateQuery() is 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 supportsStateQuery() and supportsVisibleFederation() are 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 supportsStateSearch() is 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 supportsStateSearch() and supportsVisibleFederation() are 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 supportsStateAdmin() is 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 supportsStateAdmin() and supportsVisibleFederation() are 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 supportsStateSequencing() is 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 supportsStateSequencing() and supportsVisibleFederation() are 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 supportsStateNotification() is 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 supportsStateNotfication() and supportsVisibleFederation() are 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 supportsProcessLookup() is 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 supportsProcessQuery() is 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 supportsProcessSearch() is 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 supportsProcessAdmin() is 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 supportsProcessNotification() is 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 supportsProcessHierarchy() is 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 supportsProcessHierarchyDesign() is true.