Interface AssetContentNotificationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface AssetContentNotificationSession extends OsidSession

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 .

  • Method Details

    • getRepositoryId

      Id getRepositoryId()
      Gets the Repository Id associated with this session.
      Returns:
      the Repository Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getRepository

      Repository getRepository() throws OperationFailedException, PermissionDeniedException
      Gets the Repository associated with this session.
      Returns:
      the repository
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForAssetContentNotifications

      boolean canRegisterForAssetContentNotifications()
      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.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedRepositoryView

      void useFederatedRepositoryView()
      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.

    • useIsolatedRepositoryView

      void useIsolatedRepositoryView()
      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.

    • reliableAssetContentNotifications

      void reliableAssetContentNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeAssetContentNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableAssetContentNotifications

      void unreliableAssetContentNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeAssetContentNotification

      void acknowledgeAssetContentNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge an asset content notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewAssetContents

      void registerForNewAssetContents() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new asset contents. AssetContentReceiver.newAssetContents() is invoked when a new AssetContent appears in this repository.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewAssetContentsForAsset

      void registerForNewAssetContentsForAsset(Id assetId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new asset contents for the given asset.. AssetContentReceiver.newAssetContents() is invoked when a new AssetContent appears in this repository.
      Parameters:
      assetId - the Id of the Asset to monitor
      Throws:
      NullArgumentException - assetId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAssetContents

      void registerForChangedAssetContents() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated asset contents. AssetContentReceiver.changedAssetContents() is invoked when an AssetContent in this repository is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChhangedAssetContentsForAsset

      void registerForChhangedAssetContentsForAsset(Id assetId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated asset contents for the given asset.. AssetContentReceiver.changedAssetContents() is invoked when a new AssetContent in this repository is changed.
      Parameters:
      assetId - the Id of the Asset to monitor
      Throws:
      NullArgumentException - assetId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAssetContent

      void registerForChangedAssetContent(Id assetContentId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated asset content. AssetContentReceiver.changedAssetContents() is invoked when the specified AssetContent in this repository is changed.
      Parameters:
      assetContentId - the Id of the AssetContent to monitor
      Throws:
      NullArgumentException - assetContentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssetContents

      void registerForDeletedAssetContents() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted asset contents. AssetContentReceiver.deletedAssetContents() is invoked when an asset content is deleted or removed from this repository.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssetContentsForAsset

      void registerForDeletedAssetContentsForAsset(Id assetId) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      assetId - the Id of the Asset to monitor
      Throws:
      NullArgumentException - assetId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssetContent

      void registerForDeletedAssetContent(Id assetContentId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted asset content. AssetContentReceiver.deletedAssetContents() is invoked when the specified asset content is deleted or removed from this repository.
      Parameters:
      assetContentId - the Id of the AssetContent to monitor
      Throws:
      NullArgumentException - assetContentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.