OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.ProcessManager
Implementsosid.OsidManager
osid.process.ProcessProfile
Description

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
MethodgetStateSession
Description

Gets the OsidSession associated with the state service.

Returnosid.process.StateSession a StateLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsState() is false
ComplianceoptionalThis method must be implemented if supportsState() is true.
MethodgetStateSessionForProcess
Description

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

Parametersosid.id.IdprocessIdthe Id of the process
Returnosid.process.StateSession a StateStateSession
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsState() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsState() and supportsVisibleFederation() are true.
MethodgetStateAssignmentSession
Description

Gets the OsidSession associated with the state assignment service.

Returnosid.process.StateAssignmentSession a StateAssignmentLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStateAssignment() is false
ComplianceoptionalThis method must be implemented if supportsStateAssignment() is true.
MethodgetStateAssignmentSessionForProcess
Description

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

Parametersosid.id.IdprocessIdthe Id of the process
Returnosid.process.StateAssignmentSession a StateAssignmentStateSession
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsStateAssignment() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStateAssignment() and supportsVisibleFederation() are true.
MethodgetStateChangeNotificationSession
Description

Gets the notification session for notifications pertaining to state changes.

Parametersosid.process.StateChangeReceiverstateChangeReceiverthe notification callback
Returnosid.process.StateNotificationSession a StateChangeNotificationSession
ErrorsNULL_ARGUMENT stateChangeReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStateChangeNotification() is false
ComplianceoptionalThis method must be implemented if supportsStateChangeNotification() is true.
MethodgetStateChangeNotificationSessionForProcess
Description

Gets the state change notification session for the given process.

Parametersosid.process.StateChangeReceiverstateChangeReceiverthe notification callback
osid.id.IdprocessIdthe Id of the process
Returnosid.process.StateNotificationSession a StateChangeNotificationSession
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT stateChangeReceiver or processId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsStateChangeNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStateChangeNotfication() and supportsVisibleFederation() are true.
MethodgetStateLookupSession
Description

Gets the OsidSession associated with the state lookup service.

Returnosid.process.StateLookupSession a StateLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStateLookup() is false
ComplianceoptionalThis method must be implemented if supportsStateLookup() is true.
MethodgetStateLookupSessionForProcess
Description

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

Parametersosid.id.IdprocessIdthe Id of the process
Returnosid.process.StateLookupSession a StateLookupSession
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsStateLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStateLookup() and supportsVisibleFederation() are true.
MethodgetStateQuerySession
Description

Gets a state query session.

Returnosid.process.StateQuerySession a StatQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStateQuery() is false
ComplianceoptionalThis method must be implemented if supportsStateQuery() is true.
MethodgetStateQuerySessionForProcess
Description

Gets a state query session for the given process.

Parametersosid.id.IdprocessIdthe Id of the process
Returnosid.process.StateQuerySession a StateQuerySession
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsStateQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStateQuery() and supportsVisibleFederation() are true.
MethodgetStateSearchSession
Description

Gets a state search session.

Returnosid.process.StateSearchSession a StateSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStateSearch() is false
ComplianceoptionalThis method must be implemented if supportsStateSearch() is true.
MethodgetStateSearchSessionForProcess
Description

Gets a state search session for the given process.

Parametersosid.id.IdprocessIdthe Id of the process
Returnosid.process.StateSearchSession a StateSearchSession
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsStateSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStateSearch() and supportsVisibleFederation() are true.
MethodgetStateAdminSession
Description

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

Returnosid.process.StateAdminSession a StateAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStateAdmin() is false
ComplianceoptionalThis method must be implemented if supportsStateAdmin() is true.
MethodgetStateAdminSessionForProcess
Description

Gets a state administration session for the given process.

Parametersosid.id.IdprocessIdthe Id of the process
Returnosid.process.StateAdminSession a StateAdminSession
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStateAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStateAdmin() and supportsVisibleFederation() are true.
MethodgetStateSequencingSession
Description

Gets a state sequencing session for ordering states.

Returnosid.process.StateSequencingSession a StateSequencingSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStateSequencing() is false
ComplianceoptionalThis method must be implemented if supportsStateSequencing() is true.
MethodgetStateSequencingSessionForProcess
Description

Gets a state sequencing session for the given process.

Parametersosid.id.IdprocessIdthe Id of the process
Returnosid.process.StateSequencingSession a StateSequencingSession
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStateSequencing() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStateSequencing() and supportsVisibleFederation() are true.
MethodgetStateNotificationSession
Description

Gets the notification session for notifications pertaining to state changes.

Parametersosid.process.StateReceiverstateReceiverthe notification callback
Returnosid.process.StateNotificationSession a StateNotificationSession
ErrorsNULL_ARGUMENT stateReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStateNotification() is false
ComplianceoptionalThis method must be implemented if supportsStateNotification() is true.
MethodgetStateNotificationSessionForProcess
Description

Gets the state notification session for the given process.

Parametersosid.process.StateReceiverstateReceiverthe notification callback
osid.id.IdprocessIdthe Id of the process
Returnosid.process.StateNotificationSession a StateNotificationSession
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT stateReceiver or processId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsStateNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStateNotfication() and supportsVisibleFederation() are true.
MethodgetProcessLookupSession
Description

Gets the process lookup session.

Returnosid.process.ProcessLookupSessiona ProcessLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessLookup() is true.
MethodgetProcessQuerySession
Description

Gets the process query session.

Returnosid.process.ProcessQuerySessiona ProcessQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessQuery() is false
ComplianceoptionalThis method must be implemented if supportsProcessQuery() is true.
MethodgetProcessSearchSession
Description

Gets the process search session.

Returnosid.process.ProcessSearchSessiona ProcessSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessSearch() is false
ComplianceoptionalThis method must be implemented if supportsProcessSearch() is true.
MethodgetProcessAdminSession
Description

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

Returnosid.process.ProcessAdminSessiona ProcessAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProcessAdmin() is true.
MethodgetProcessNotificationSession
Description

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

Parametersosid.process.ProcessReceiverprocessReceiverthe notification callback
Returnosid.process.ProcessNotificationSessiona ProcessNotificationSession
ErrorsNULL_ARGUMENT processReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessNotification() is false
ComplianceoptionalThis method must be implemented if supportsProcessNotification() is true.
MethodgetProcessHierarchySession
Description

Gets the process hierarchy traversal session.

Returnosid.process.ProcessHierarchySession a ProcessHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsProcessHierarchy() is true.
MethodgetProcessHierarchyDesignSession
Description

Gets the process hierarchy design session.

Returnosid.process.ProcessHierarchyDesignSessiona ProcessHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsProcessHierarchyDesign() is true.