| Interface | osid.resourcing.rules.JobProcessorEnablerNotificationSession | ||
|---|---|---|---|
| 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 | canRegisterForJobProcessorEnablerNotifications | ||
| 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 enablers 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 | registerForNewJobProcessorEnablers | ||
| Description |
Register for notifications of new job processor
enablers. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedJobProcessorEnablers | ||
| Description |
Registers for notification of updated foundry enabelrs.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedJobProcessorEnabler | ||
| Description |
Registers for notification of an updated job processor
enabler. | ||
| Parameters | osid.id.Id | jobProcessorEnablerId | the Id of the JobProcessorEnabler to monitor |
| Errors | NULL_ARGUMENT | jobProcessorEnablerId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedJobProcessorEnablers | ||
| Description |
Registers for notification of deleted job processor
enablers. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedJobProcessorEnabler | ||
| Description |
Registers for notification of a deleted job processor
enabler. | ||
| Parameters | osid.id.Id | jobProcessorEnablerId | the Id of the JobProcessorEnabler to monitor |
| Errors | NULL_ARGUMENT | jobProcessorEnablerId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |