| Interface | osid.repository.AssetContentNotificationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.repository.RepositoryManager | ||
osid.repository.RepositoryProxyManager | |||
| 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 | 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 | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canRegisterForAssetContentNotifications | ||
| 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 methods in this session. A federated view will include asset contents 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 methods in this session. An isolated view restricts notifications to this repository only. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | reliableAssetContentNotifications | ||
| Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using
| ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | unreliableAssetContentNotifications | ||
| Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | acknowledgeAssetContentNotification | ||
| Description |
Acknowledge an asset content 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 | registerForNewAssetContents | ||
| Description |
Register for notifications of new asset contents.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForNewAssetContentsForAsset | ||
| Description |
Register for notifications of new asset contents for
the given asset..
| ||
| Parameters | osid.id.Id | assetId | the Id of the Asset to monitor |
| Errors | NULL_ARGUMENT | assetId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedAssetContents | ||
| Description |
Register for notifications of updated asset contents.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChhangedAssetContentsForAsset | ||
| Description |
Register for notifications of updated asset contents
for the given asset..
| ||
| Parameters | osid.id.Id | assetId | the Id of the Asset to monitor |
| Errors | NULL_ARGUMENT | assetId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedAssetContent | ||
| Description |
Register for notifications of an updated asset
content.
| ||
| Parameters | osid.id.Id | assetContentId | the Id of the AssetContent to monitor |
| Errors | NULL_ARGUMENT | assetContentId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedAssetContents | ||
| Description |
Registers for notification of deleted asset contents.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedAssetContentsForAsset | ||
| Description |
Register for notifications of deleted asset contents
for the given asset..
| ||
| Parameters | osid.id.Id | assetId | the Id of the Asset to monitor |
| Errors | NULL_ARGUMENT | assetId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedAssetContent | ||
| Description |
Registers for notification of a deleted asset content.
| ||
| Parameters | osid.id.Id | assetContentId | the Id of the AssetContent to monitor |
| Errors | NULL_ARGUMENT | assetContentId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |