Interface | osid.workflow.StepNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Office Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffice | ||
Description |
Gets the | ||
Return | osid.workflow.Office | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForStepNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include steps in offices which are children of this office in the office hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedOfficeView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this office only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewSteps | ||
Description |
Register for notifications of new steps. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewStepsForProcess | ||
Description |
Register for notifications of new steps in the given
process | ||
Parameters | osid.id.Id | processId | the Id of the process to monitor |
Errors | NULL_ARGUMENT | processId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedSteps | ||
Description |
Registers for notification of updated steps. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedStepsForProcess | ||
Description |
Register for notifications of updated steps for the
given process | ||
Parameters | osid.id.Id | processId | the Id of the process to monitor |
Errors | NULL_ARGUMENT | processId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedStep | ||
Description |
Registers for notification of an updated step. | ||
Parameters | osid.id.Id | stepId | the Id of the Step to monitor |
Errors | NULL_ARGUMENT | stepId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedSteps | ||
Description |
Registers for notification of deleted steps. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedStepsForProcess | ||
Description |
Register for notifications of deleted steps for the
given process | ||
Parameters | osid.id.Id | processId | the Id of the process to monitor |
Errors | NULL_ARGUMENT | processId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedStep | ||
Description |
Registers for notification of a deleted step. | ||
Parameters | osid.id.Id | stepId | the Id of the Step to monitor |
Errors | NULL_ARGUMENT | stepId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |