org.osid.process

Interface ProcessManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, ProcessProfile, Sourceable

public interface ProcessManager
extends OsidManager, ProcessProfile

The state manager provides access to state lookup and creation sessions and provides interoperability tests for various aspects of this service. 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() Gets the process administrative session for creating, updating and deleteing processes.
ProcessHierarchyDesignSession	getProcessHierarchyDesignSession() Gets the process hierarchy design session.
ProcessHierarchySession	getProcessHierarchySession() Gets the process hierarchy traversal session.
ProcessLookupSession	getProcessLookupSession() Gets the process lookup session.
ProcessNotificationSession	getProcessNotificationSession(ProcessReceiver processReceiver) Gets the notification session for subscriprocessg to changes to a process.
ProcessQuerySession	getProcessQuerySession() Gets the process query session.
ProcessSearchSession	getProcessSearchSession() Gets the process search session.
StateAdminSession	getStateAdminSession() Gets a state administration session for creating, updating and deleting states.
StateAdminSession	getStateAdminSessionForProcess(Id processId) Gets a state administration session for the given process.
StateAssignmentSession	getStateAssignmentSession() Gets the OsidSession associated with the state assignment service.
StateAssignmentSession	getStateAssignmentSessionForProcess(Id processId) Gets the OsidSession associated with the state assignment service for the given process.
StateNotificationSession	getStateChangeNotificationSession(StateChangeReceiver stateChangeReceiver) Gets the notification session for notifications pertaining to state changes.
StateNotificationSession	getStateChangeNotificationSessionForProcess(StateChangeReceiver stateChangeReceiver, Id processId) Gets the state change notification session for the given process.
StateLookupSession	getStateLookupSession() Gets the OsidSession associated with the state lookup service.
StateLookupSession	getStateLookupSessionForProcess(Id processId) Gets the OsidSession associated with the state lookup service for the given process.
StateNotificationSession	getStateNotificationSession(StateReceiver stateReceiver) Gets the notification session for notifications pertaining to state changes.
StateNotificationSession	getStateNotificationSessionForProcess(StateReceiver stateReceiver, Id processId) Gets the state notification session for the given process.
StateQuerySession	getStateQuerySession() Gets a state query session.
StateQuerySession	getStateQuerySessionForProcess(Id processId) Gets a state query session for the given process.
StateSearchSession	getStateSearchSession() Gets a state search session.
StateSearchSession	getStateSearchSessionForProcess(Id processId) Gets a state search session for the given process.
StateSequencingSession	getStateSequencingSession() Gets a state sequencing session for ordering states.
StateSequencingSession	getStateSequencingSessionForProcess(Id processId) Gets a state sequencing session for the given process.
StateSession	getStateSession() Gets the OsidSession associated with the state service.
StateSession	getStateSessionForProcess(Id processId) Gets the OsidSession associated with the state service for the given process.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                             throws OperationFailedException

Gets the OsidSession associated with the state service.

Returns:

a StateLookupSession

Throws:

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)
                                       throws NotFoundException,
                                              OperationFailedException

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

Parameters:

processId - the Id of the process

Returns:

a StateStateSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the state assignment service.

Returns:

a StateAssignmentLookupSession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

processId - the Id of the process

Returns:

a StateAssignmentStateSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId 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)
                                                           throws OperationFailedException

Gets the notification session for notifications pertaining to state changes.

Parameters:

stateChangeReceiver - the notification callback

Returns:

a StateChangeNotificationSession

Throws:

NullArgumentException - stateChangeReceiver 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)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the state change notification session for the given process.

Parameters:

stateChangeReceiver - the notification callback

processId - the Id of the process

Returns:

a StateChangeNotificationSession

Throws:

NotFoundException - processId not found

NullArgumentException - stateChangeReceiver or processId 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the state lookup service.

Returns:

a StateLookupSession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

processId - the Id of the process

Returns:

a StateLookupSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId 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()
                                       throws OperationFailedException

Gets a state query session.

Returns:

a StatQuerySession

Throws:

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)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets a state query session for the given process.

Parameters:

processId - the Id of the process

Returns:

a StateQuerySession

Throws:

NotFoundException - processId not found

NullArgumentException - processId 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()
                                         throws OperationFailedException

Gets a state search session.

Returns:

a StateSearchSession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets a state search session for the given process.

Parameters:

processId - the Id of the process

Returns:

a StateSearchSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId 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()
                                       throws OperationFailedException

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

Returns:

a StateAdminSession

Throws:

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)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets a state administration session for the given process.

Parameters:

processId - the Id of the process

Returns:

a StateAdminSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId 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()
                                                 throws OperationFailedException

Gets a state sequencing session for ordering states.

Returns:

a StateSequencingSession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets a state sequencing session for the given process.

Parameters:

processId - the Id of the process

Returns:

a StateSequencingSession

Throws:

NotFoundException - processId not found

NullArgumentException - processId 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)
                                                     throws OperationFailedException

Gets the notification session for notifications pertaining to state changes.

Parameters:

stateReceiver - the notification callback

Returns:

a StateNotificationSession

Throws:

NullArgumentException - stateReceiver 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)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the state notification session for the given process.

Parameters:

stateReceiver - the notification callback

processId - the Id of the process

Returns:

a StateNotificationSession

Throws:

NotFoundException - processId not found

NullArgumentException - stateReceiver or processId 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()
                                             throws OperationFailedException

Gets the process lookup session.

Returns:

a ProcessLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessLookup() is false

Compliance:

optional - This method must be implemented if supportsProcessLookup() is true.

getProcessQuerySession

ProcessQuerySession getProcessQuerySession()
                                           throws OperationFailedException

Gets the process query session.

Returns:

a ProcessQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessQuery() is false

Compliance:

optional - This method must be implemented if supportsProcessQuery() is true.

getProcessSearchSession

ProcessSearchSession getProcessSearchSession()
                                             throws OperationFailedException

Gets the process search session.

Returns:

a ProcessSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessSearch() is false

Compliance:

optional - This method must be implemented if supportsProcessSearch() is true.

getProcessAdminSession

ProcessAdminSession getProcessAdminSession()
                                           throws OperationFailedException

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

Returns:

a ProcessAdminSession

Throws:

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)
                                                         throws OperationFailedException

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

Parameters:

processReceiver - the notification callback

Returns:

a ProcessNotificationSession

Throws:

NullArgumentException - processReceiver 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()
                                                   throws OperationFailedException

Gets the process hierarchy traversal session.

Returns:

a ProcessHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessHierarchy() is false

Compliance:

optional - This method must be implemented if supportsProcessHierarchy() is true.

getProcessHierarchyDesignSession

ProcessHierarchyDesignSession getProcessHierarchyDesignSession()
                                                               throws OperationFailedException

Gets the process hierarchy design session.

Returns:

a ProcessHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsProcessHierarchyDesign() is true.