OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.WorkflowProxyManager
Implementsosid.OsidProxyManager
osid.workflow.WorkflowProfile
Description

The workflow proxy manager provides access to rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

  • ProcessLookupSession: a session to retrieve processs
  • ProcessQuerySession: a session to query for processs
  • ProcessSearchSession: a session to search for processs
  • ProcessAdminSession: a session to create and delete processs
  • ProcessNotificationSession: a session to receive notifications pertaining to process changes
  • ProcessOfficeSession: a session to looking mappings of process to offices
  • ProcessOfficeAssignmentSession: a session to manage process to office workflows
  • ProcessSmartOfficeSession: a session to manage dynamic offices of processs
  • StepLookupSession: a session to retrieve steps
  • StepQuerySession: a session to query for steps
  • StepSearchSession: a session to search for steps
  • StepAdminSession: a session to create and delete steps
  • StepNotificationSession: a session to receive notifications pertaining to step changes
  • StepOfficeSession: a session to look up step office mappings
  • StepOfficeAssignmentSession: a session to manage steps to office mappings
  • StepSmartOfficeSession: a session to manage dynamic offices of stepss
  • WorkLookupSession: a session to retrieve work
  • WorkQuerySession: a session to query for work
  • WorkSearchSession: a session to search for work
  • WorkAdminSession: a session to create and delete work
  • WorkNotificationSession: a session to receive notifications pertaining to work changes
  • WorkOfficeSession: a session to look up work office mappings
  • WorkOfficeAssignmentSession: a session to manage availability to office mappings
  • WorkSmartOfficeSession: a session to manage dynamic offices of work
  • WorkflowSession: a session to examine work in a process
  • WorkflowInitiationSession: a session to start work through a process
  • WorkflowManagementSession: a session to enable and disable work in a process
  • ManualWorkflowSession: a session to manuall assign work to steps in a process
  • WorkflowLogSession: a session to look up changes in a workflow
  • WorkflowEventNotificationSession: a session to receive notifications of workflow changes
  • OfficeLookupSession: a session to retrieve offices
  • OfficeQuerySession: a session to search for offices
  • OfficeSearchSession: a session to search for offices
  • OfficeAdminSession: a session to create and delete offices
  • OfficeNotificationSession: a session to receive notifications pertaining to office changes
  • OfficeHierarchySession: a session to traverse a hierarchy of office
  • OfficeHierarchyDesignSession: a session to manage a office hierarchy
MethodgetProcessLookupSession
Description

Gets the OsidSession associated with the process lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessLookupSessiona ProcessLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessLookup() is true.
MethodgetProcessLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessLookupSessiona ProcessLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessLookup() and supportsVisibleFederation() are true
MethodgetProcessQuerySession
Description

Gets the OsidSession associated with the process query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessQuerySessiona ProcessQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessQuery() is false
ComplianceoptionalThis method must be implemented if supportsProcessQuery() is true.
MethodgetProcessQuerySessionForOffice
Description

Gets the OsidSession associated with the process query service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessQuerySessiona ProcessQuerySession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessQuery() and supportsVisibleFederation() are true
MethodgetProcessSearchSession
Description

Gets the OsidSession associated with the process search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessSearchSessiona ProcessSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessSearch() is false
ComplianceoptionalThis method must be implemented if supportsProcessSearch() is true.
MethodgetProcessSearchSessionForOffice
Description

Gets the OsidSession associated with the process search service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessSearchSessiona ProcessSearchSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessSearch() and supportsVisibleFederation() are true
MethodgetProcessAdminSession
Description

Gets the OsidSession associated with the process administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessAdminSessiona ProcessAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProcessAdmin() is true.
MethodgetProcessAdminSessionForOffice
Description

Gets the OsidSession associated with the process administration service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessAdminSessiona ProcessAdminSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessAdmin() and supportsVisibleFederation() are true
MethodgetProcessNotificationSession
Description

Gets the OsidSession associated with the process notification service.

Parametersosid.workflow.ProcessReceiverprocessReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessNotificationSessiona ProcessNotificationSession
ErrorsNULL_ARGUMENT processReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessNotification() is false
ComplianceoptionalThis method must be implemented if supportsProcessNotification() is true.
MethodgetProcessNotificationSessionForOffice
Description

Gets the OsidSession associated with the process notification service for the given office.

Parametersosid.workflow.ProcessReceiverprocessReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessNotificationSessiona ProcessNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT processReceiver, officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessNotification() and supportsVisibleFederation() are true
MethodgetProcessOfficeSession
Description

Gets the OsidSession to lookup process/office mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessOfficeSessiona ProcessOfficeSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessOffice() is true.
MethodgetProcessOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning process to offices.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessOfficeAssignmentSessiona ProcessOfficeAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProcessOfficeAssignment() is true.
MethodgetProcessSmartOfficeSession
Description

Gets the OsidSession to manage process smart offices.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.ProcessSmartOfficeSessiona ProcessSmartOfficeSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessSmartOffice() is true.
MethodgetStepLookupSession
Description

Gets the OsidSession associated with the step lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.StepLookupSessionan StepLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepLookup() is true.
MethodgetStepLookupSessionForOffice
Description

Gets the OsidSession associated with the step lookup service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.StepLookupSessionan StepLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepLookup() and supportsVisibleFederation() are true
MethodgetStepQuerySession
Description

Gets the OsidSession associated with the step query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.StepQuerySessionan StepQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepQuery() is false
ComplianceoptionalThis method must be implemented if supportsStepQuery() is true.
MethodgetStepQuerySessionForOffice
Description

Gets the OsidSession associated with the step query service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.StepQuerySessionan StepQuerySession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepQuery() and supportsVisibleFederation() are true
MethodgetStepSearchSession
Description

Gets the OsidSession associated with the step search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.StepSearchSessionan StepSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepSearch() is false
ComplianceoptionalThis method must be implemented if supportsStepSearch() is true.
MethodgetStepSearchSessionForOffice
Description

Gets the OsidSession associated with the step search service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.StepSearchSessionan StepSearchSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepSearch() and supportsVisibleFederation() are true
MethodgetStepAdminSession
Description

Gets the OsidSession associated with the step administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.StepAdminSessionan StepAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepAdmin() is false
ComplianceoptionalThis method must be implemented if supportsStepAdmin() is true.
MethodgetStepAdminSessionForOffice
Description

Gets the OsidSession associated with the step administration service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.StepAdminSessionan StepAdminSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepAdmin() and supportsVisibleFederation() are true
MethodgetStepNotificationSession
Description

Gets the OsidSession associated with the step notification service.

Parametersosid.workflow.StepReceiverstepReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.workflow.StepNotificationSessionan StepNotificationSession
ErrorsNULL_ARGUMENT stepReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepNotification() is false
ComplianceoptionalThis method must be implemented if supportsStepNotification() is true.
MethodgetStepNotificationSessionForOffice
Description

Gets the OsidSession associated with the step notification service for the given office.

Parametersosid.workflow.StepReceiverstepReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.StepNotificationSessionan StepNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT stepReceiver, officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepNotification() and supportsVisibleFederation() are true
MethodgetStepOfficeSession
Description

Gets the OsidSession to lookup step/office mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.StepOfficeSessionan StepOfficeSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepOffice() is true.
MethodgetStepOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning steps to offices.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.StepOfficeAssignmentSessionan StepOfficeAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsStepOfficeAssignment() is true.
MethodgetStepSmartOfficeSession
Description

Gets the OsidSession to manage step smart offices.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.StepOfficeSessionan StepSmartOfficeSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepSmartOffice() is true.
MethodgetWorkLookupSession
Description

Gets the OsidSession associated with the work lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkLookupSessiona WorkLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkLookup() is false
ComplianceoptionalThis method must be implemented if supportsWorkLookup() is true.
MethodgetWorkLookupSessionForOffice
Description

Gets the OsidSession associated with the work lookup service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkLookupSessiona WorkLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkLookup() and supportsVisibleFederation() are true
MethodgetWorkQuerySession
Description

Gets the OsidSession associated with the work query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkQuerySessiona WorkQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkQuery() is false
ComplianceoptionalThis method must be implemented if supportsWorkQuery() is true.
MethodgetWorkQuerySessionForOffice
Description

Gets the OsidSession associated with the work query service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkQuerySessiona WorkQuerySession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkQuery() and supportsVisibleFederation() are true
MethodgetWorkSearchSession
Description

Gets the OsidSession associated with the work search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkSearchSessiona WorkSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkSearch() is false
ComplianceoptionalThis method must be implemented if supportsWorkSearch() is true.
MethodgetWorkSearchSessionForOffice
Description

Gets the OsidSession associated with the work search service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkSearchSessiona WorkSearchSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkSearch() and supportsVisibleFederation() are true
MethodgetWorkAdminSession
Description

Gets the OsidSession associated with the work administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkAdminSessiona WorkAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkAdmin() is false
ComplianceoptionalThis method must be implemented if supportsWorkAdmin() is true.
MethodgetWorkAdminSessionForOffice
Description

Gets the OsidSession associated with the work administration service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkAdminSessiona WorkAdminSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkAdmin() and supportsVisibleFederation() are true
MethodgetWorkNotificationSession
Description

Gets the OsidSession associated with the work notification service.

Parametersosid.workflow.WorkReceiverworkReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkNotificationSessiona WorkNotificationSession
ErrorsNULL_ARGUMENT workReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkNotification() is false
ComplianceoptionalThis method must be implemented if supportsWorkNotification() is true.
MethodgetWorkNotificationSessionForOffice
Description

Gets the OsidSession associated with the work notification service for the given office.

Parametersosid.workflow.WorkReceiverworkReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkNotificationSessiona WorkNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT workReceiver, officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkNotification() and supportsVisibleFederation() are true
MethodgetWorkOfficeSession
Description

Gets the OsidSession to lookup work/office mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkOfficeSessiona WorkOfficeSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkOffice() is false
ComplianceoptionalThis method must be implemented if supportsWorkOffice() is true.
MethodgetWorkOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning work to offices.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkOfficeAssignmentSessiona WorkOfficeAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkbOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsWorkOfficeAssignment() is true.
MethodgetWorkSmartOfficeSession
Description

Gets the OsidSession to manage work smart offices.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkSmartOfficeSessiona WorkSmartOfficeSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTno Office found by the given Id
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsWorkSmartOffice() is true.
MethodgetWorkflowSession
Description

Gets the OsidSession for a workflow service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkflowSessiona WorkflowSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflow() is false
ComplianceoptionalThis method must be implemented if supportsWorkflow() is true.
MethodgetWorkflowSessionForOffice
Description

Gets the OsidSession for a workflow service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkflowSessiona WorkflowSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflow() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkflow() and supportsVisibleFederation() are true
MethodgetWorkflowInitiationSession
Description

Gets the OsidSession for a workflow initiation service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkflowInitiationSessiona WorkflowInitiationSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflowInitiation() is false
ComplianceoptionalThis method must be implemented if supportsWorkflowInitiation() is true.
MethodgetWorkflowInitiationSessionForOffice
Description

Gets the OsidSession for a workflow initiation service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkflowInitiationSessiona WorkflowInitiationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflowInitiation() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkflowInitiation() and supportsVisibleFederation() are true
MethodgetWorkflowManagementSession
Description

Gets the OsidSession for a workflow management service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkflowManagementSessiona WorkflowManagementSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflowManagement() is false
ComplianceoptionalThis method must be implemented if supportsWorkflowManagement() is true.
MethodgetWorkflowManagementSessionForOffice
Description

Gets the OsidSession for a workflow management service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkflowManagementSessiona WorkflowManagementSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflowManagement() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkflowManagement() and supportsVisibleFederation() are true
MethodgetManualWorkflowSession
Description

Gets the OsidSession for a manual workflow service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.ManualWorkflowSessiona ManualWorkflowSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsManualWorkflow() is false
ComplianceoptionalThis method must be implemented if supportsManualWorkflow() is true.
MethodgetManualWorkflowSessionForOffice
Description

Gets the OsidSession for a manual workflow service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.ManualWorkflowSessiona ManualWorkflowSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsManualWorkflow() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsManualWorkflow() and supportsVisibleFederation() are true
MethodgetWorkflowEventLookupSession
Description

Gets the OsidSession for a workflow event lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkflowEventLookupSessiona WorkflowEventLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflowEventLookup() is false
ComplianceoptionalThis method must be implemented if supportsWorkflowEventLookup() is true.
MethodgetWorkflowEventLookupSessionForOffice
Description

Gets the OsidSession for a workflow event lookup service for the given office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkflowEventLookupSessiona WorkflowEventLookupSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflowEventLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkflowEventLookup() and supportsVisibleFederation() are true
MethodgetWorkflowEventNotificationSession
Description

Gets the OsidSession associated with the workflow event notification service.

Parametersosid.workflow.WorkflowEventReceiverworkflowEventReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkflowEventNotificationSessiona WorkflowEventNotificationSession
ErrorsNULL_ARGUMENT workflowEventReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflowEventNotification() is false
ComplianceoptionalThis method must be implemented if supportsWorkflowEventNotification() is true
MethodgetWorkflowEventNotificationSessionForOffice
Description

Gets the OsidSession associated with the workflow event notification service for the given office.

Parametersosid.workflow.WorkflowEventReceiverworkflowEventReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.WorkflowEventNotificationSessiona WorkflowEventNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT workflowEventReceiver, officeId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflowEventNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkflowEventNotification() and supportsVisibleFederation() are true
MethodgetOfficeLookupSession
Description

Gets the OsidSession associated with the office lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.OfficeLookupSessiona OfficeLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOfficeLookup() is false
ComplianceoptionalThis method must be implemented if supportsOfficeLookup() is true.
MethodgetOfficeQuerySession
Description

Gets the OsidSession associated with the office query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.OfficeQuerySessiona OfficeQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOfficeQuery() is false
ComplianceoptionalThis method must be implemented if supportsOfficeQuery() is true.
MethodgetOfficeSearchSession
Description

Gets the OsidSession associated with the office search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.OfficeSearchSessiona OfficeSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOfficeSearch() is false
ComplianceoptionalThis method must be implemented if supportsOfficeSearch() is true.
MethodgetOfficeAdminSession
Description

Gets the OsidSession associated with the office administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.OfficeAdminSessiona OfficeAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOfficeAdmin() is false
ComplianceoptionalThis method must be implemented if supportsOfficeAdmin() is true.
MethodgetOfficeNotificationSession
Description

Gets the OsidSession associated with the office notification service.

Parametersosid.workflow.OfficeReceiverofficeReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.workflow.OfficeNotificationSessiona OfficeNotificationSession
ErrorsNULL_ARGUMENT officeReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOfficeNotification() is false
ComplianceoptionalThis method must be implemented if supportsOfficeNotification() is true.
MethodgetOfficeHierarchySession
Description

Gets the OsidSession associated with the office hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.OfficeHierarchySessiona OfficeHierarchySession for offices
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOfficeHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsOfficeHierarchy() is true.
MethodgetOfficeHierarchyDesignSession
Description

Gets the OsidSession associated with the office hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.OfficeHierarchyDesignSessiona HierarchyDesignSession for offices
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOfficeHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsOfficeHierarchyDesign() is true.
MethodgetWorkflowBatchProxyManager
Description

Gets a WorkflowBatchProxyManager.

Returnosid.workflow.batch.WorkflowBatchProxyManagera WorkflowbatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflowBatch() is false
ComplianceoptionalThis method must be implemented if supportsWorkflowBatch() is true.
MethodgetWorkflowRulesProxyManager
Description

Gets a WorkflowRulesProxyManager .

Returnosid.workflow.rules.WorkflowRulesProxyManagera WorkflowRulesProxyManager for offices
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkflowRules() is false
ComplianceoptionalThis method must be implemented if supportsWorkflowRules() is true.