OSID Logo
OSID Specifications
repository package
Version 3.1.0
Interfaceosid.repository.AssetContentNotificationSession
Implementsosid.OsidSession
Used Byosid.repository.RepositoryManager
osid.repository.RepositoryProxyManager
Description

This session defines methods to receive notifications on adds/changes to AssetContents in this Repository. This also includes existing asset contents that may appear or disappear due to changes in the Repository hier archy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the AssetContentLookupSession.

MethodgetRepositoryId
Description

Gets the Repository Id associated with this session.

Returnosid.id.Id the Repository Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetRepository
Description

Gets the Repository associated with this session.

Returnosid.repository.Repository the repository
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanRegisterForAssetContentNotifications
Description

Tests if this user can register for AssetContent notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethoduseFederatedRepositoryView
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.

Compliancemandatory This method is must be implemented.
MethoduseIsolatedRepositoryView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this repository only.

Compliancemandatory This method is must be implemented.
MethodreliableAssetContentNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeAssetContentNotification().

Compliancemandatory This method is must be implemented.
MethodunreliableAssetContentNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

Compliancemandatory This method is must be implemented.
MethodacknowledgeAssetContentNotification
Description

Acknowledge an asset content notification.

Parametersosid.id.IdnotificationId the Id of the notification
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForNewAssetContents
Description

Register for notifications of new asset contents. AssetContentReceiver.newAssetContents() is invoked when a new AssetContent appears in this repository.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForNewAssetContentsForAsset
Description

Register for notifications of new asset contents for the given asset.. AssetContentReceiver.newAssetContents() is invoked when a new AssetContent appears in this repository.

Parametersosid.id.IdassetId the Id of the Asset to monitor
ErrorsNULL_ARGUMENT assetId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAssetContents
Description

Register for notifications of updated asset contents. AssetContentReceiver.changedAssetContents() is invoked when an AssetContent in this repository is changed.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChhangedAssetContentsForAsset
Description

Register for notifications of updated asset contents for the given asset.. AssetContentReceiver.changedAssetContents() is invoked when a new AssetContent in this repository is changed.

Parametersosid.id.IdassetId the Id of the Asset to monitor
ErrorsNULL_ARGUMENT assetId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAssetContent
Description

Register for notifications of an updated asset content. AssetContentReceiver.changedAssetContents() is invoked when the specified AssetContent in this repository is changed.

Parametersosid.id.IdassetContentId the Id of the AssetContent to monitor
ErrorsNULL_ARGUMENT assetContentId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForDeletedAssetContents
Description

Registers for notification of deleted asset contents. AssetContentReceiver.deletedAssetContents() is invoked when an asset content is deleted or removed from this repository.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForDeletedAssetContentsForAsset
Description

Register for notifications of deleted asset contents for the given asset.. AssetContentReceiver.deletedAssetContents() is invoked when an AssetContent in this repository is deleted or removed.

Parametersosid.id.IdassetId the Id of the Asset to monitor
ErrorsNULL_ARGUMENT assetId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForDeletedAssetContent
Description

Registers for notification of a deleted asset content. AssetContentReceiver.deletedAssetContents() is invoked when the specified asset content is deleted or removed from this repository.

Parametersosid.id.IdassetContentId the Id of the AssetContent to monitor
ErrorsNULL_ARGUMENT assetContentId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.