Interface | osid.repository.CompositionNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Two view are defined in this session:
| ||
Method | getRepositoryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Repository Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getRepository | ||
Description |
Gets the | ||
Return | osid.repository.Repository | the Repository associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForCompositionNotifications | ||
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 | useFederatedRepositoryView | ||
Description |
Federates the view for composition methods in this session. A federated view will include compositions in repositories which are children of this repository in the repository hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedRepositoryView | ||
Description |
Isolates the view for composition methods in this session. An isolated view restricts notifications to this repository only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewCompositions | ||
Description |
Register for notifications of new composition. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCompositions | ||
Description |
Register for notifications of new compositions. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedComposition | ||
Description |
Registers for notification of an updated composition.
| ||
Parameters | osid.id.Id | compositionId | the Id of the Composition to monitor |
Errors | NULL_ARGUMENT | compositionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCompositions | ||
Description |
Register for notifications of new compositions. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedComposition | ||
Description |
Registers for notification of a deleted composition.
| ||
Parameters | osid.id.Id | compositionId | the Id of the Composition to monitor |
Errors | NULL_ARGUMENT | compositionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |