Interface | osid.process.StateNotificationSession | ||
---|---|---|---|
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 | getProcessId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Process Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcess | ||
Description |
Gets the | ||
Return | osid.process.Process | the Process associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForStateNotifications | ||
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 | useFederatedProcessView | ||
Description |
Federates the view for methods in this session. A federated view will include states in processes which are children of this process in the process hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedProcessView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this process only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableStateNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableStateNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeStateNotification | ||
Description |
Acknowledge a state notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewStates | ||
Description |
Register for notifications of new states. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedStates | ||
Description |
Registers for notification of updated states. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedState | ||
Description |
Registers for notification of an updated state. | ||
Parameters | osid.id.Id | stateId | the Id of the State to monitor |
Errors | NULL_ARGUMENT | stateId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedStates | ||
Description |
Registers for notification of deleted states. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedState | ||
Description |
Registers for notification of a deleted state. | ||
Parameters | osid.id.Id | stateId | the Id of the State to monitor |
Errors | NULL_ARGUMENT | stateId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |