OSID - osid.repository.AssetNotificationSession Service Interface Definition

Interface	osid.repository.AssetNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.repository.RepositoryManager`
Used By	`osid.repository.RepositoryProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Asset` objects in this `Repository`. This also includes existing assets that may appear or disappear due to changes in the `Repository` hierarchy, 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 `AssetLookupSession`.
Method	getRepositoryId
Description	Gets the `Repository` `Id` associated with this session.
Return	`osid.id.Id`		the `Repository Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRepository
Description	Gets the `Repository` associated with this session.
Return	`osid.repository.Repository`		the `Repository` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForAssetNotifications
Description	Tests if this user can register for `Asset` 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.
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 assets 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	reliableAssetNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAssetNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAssetNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAssetNotification
Description	Acknowledge an asset notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAssets
Description	Register for notifications of new assets. `AssetReceiver.newAssets()` is invoked when a new `Asset` appears in this repository.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAssetsByGenusType
Description	Registers for notification of new assets of the given asset genus type. `AssetReceiver.newAssets()` is invoked when an asset is appears in this repository.
Parameters	`osid.type.Type`	`assetGenusType`	the genus type of the `Asset` to monitor
Errors	NULL_ARGUMENT		`assetGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAssets
Description	Registers for notification of updated assets. `AssetReceiver.changedAssets()` is invoked when an asset in this repository is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAssetsByGenusType
Description	Registers for notification of updated assets of the given asset genus type. `AssetReceiver.changedAssets()` is invoked when an asset in this repository is changed.
Parameters	`osid.type.Type`	`assetGenusType`	the genus type of the `Asset` to monitor
Errors	NULL_ARGUMENT		`assetGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAsset
Description	Registers for notification of an updated asset. `AssetReceiver.changedAssets()` is invoked when the specified asset in this repository is changed.
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	registerForDeletedAssets
Description	Registers for notification of deleted assets. `AssetReceiver.deletedAssets()` is invoked when an asset is deleted or removed from this repository.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAssetsByGenusType
Description	Registers for notification of deleted assets of the given asset genus type. `AssetReceiver.deletedAssets()` is invoked when an asset is deleted or removed from this repository.
Parameters	`osid.type.Type`	`assetGenusType`	the genus type of the `Asset` to monitor
Errors	NULL_ARGUMENT		`assetGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAsset
Description	Registers for notification of a deleted asset. `AssetReceiver.deletedAssets()` is invoked when the specified asset is deleted or removed from this repository.
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.