Interface | osid.resourcing.rules.CommissionEnablerNotificationSession | ||
---|---|---|---|
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 | getFoundryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Foundry Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFoundry | ||
Description |
Gets the | ||
Return | osid.resourcing.Foundry | the foundry | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForCommissionEnablerNotifications | ||
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 | useFederatedFoundryView | ||
Description |
Federates the view for methods in this session. A federated view will include in foundries which are children of this foundry in the foundry hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedFoundryView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this foundry only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewCommissionEnablers | ||
Description |
Register for notifications of new commission enablers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCommissionEnablers | ||
Description |
Registers for notification of updated foundries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCommissionEnabler | ||
Description |
Registers for notification of an updated commission
enabler. | ||
Parameters | osid.id.Id | commissionEnablerId | the Id of the CommissionEnabler to monitor |
Errors | NULL_ARGUMENT | commissionEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCommissionEnablers | ||
Description |
Registers for notification of deleted commission
enablers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCommissionEnabler | ||
Description |
Registers for notification of a deleted commission
enabler. | ||
Parameters | osid.id.Id | commissionEnablerId | the Id of the CommissionEnabler to monitor |
Errors | NULL_ARGUMENT | commissionEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |