OSID - osid.provisioning.RequestNotificationSession Service Interface Definition

Interface	osid.provisioning.RequestNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Request` objects in this `Distributor` . This also includes existing requests that may appear or disappear due to changes in the `Dstributor` 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 `RequestLookupSession` .
Method	getDistributorId
Description	Gets the `Distributor` `Id` associated with this session.
Return	`osid.id.Id`		the `Distributor Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDistributor
Description	Gets the `Distributor` associated with this session.
Return	`osid.provisioning.Distributor`		the distributor
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForRequestNotifications
Description	Tests if this user can register for `Request` 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	useFederatedDistributorView
Description	Federates the view for methods in this session. A federated view will include requests in distributors which are children of this distributor in the distributor hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDistributorView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableRequestNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRequestNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRequestNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRequestNotification
Description	Acknowledge a request 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	registerForNewRequests
Description	Register for notifications of new requests. `RequestReceiver.newRequests()` is invoked when a new `Request` appears in this distributor.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRequestsForResource
Description	Register for notifications of new requests for the given resource `Id` . `RequestReceiver.newRequests()` is invoked when a new `Request` is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRequestsForQueue
Description	Register for notifications of new requests for the given queue `Id` . `RequestReceiver.newRequests()` is invoked when a new `Request` is created.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the queue to monitor
Errors	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRequests
Description	Registers for notification of updated requests. `RequestReceiver.changedRequests()` is invoked when a request in this distributor is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRequestsForResource
Description	Register for notifications of updated requests for the given resource `Id` . `RequestReceiver.changedRequests()` is invoked when a `Request` in this distributor is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRequestsForQueue
Description	Register for notifications of updated requests for the given queue `Id` . `RequestReceiver.changedRequests()` is invoked when a `Request` in this distributor is changed.
Parameters	`osid.id.Id`	`queueId`	the Id of the queue to monitor
Errors	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRequest
Description	Registers for notification of an updated request. `RequestReceiver.changedRequests()` is invoked when the specified request in this distributor is changed.
Parameters	`osid.id.Id`	`requestId`	the `Id` of the `Request` to monitor
Errors	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRequests
Description	Registers for notification of deleted requests. `RequestReceiver.deletedRequests()` is invoked when a request is deleted or removed from this distributor.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRequestsForResource
Description	Register for notifications of deleted requests for the given resource `Id` . `RequestReceiver.deletedRequests()` is invoked when a `Request` is deleted or removed from this distributor.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRequestsForQueue
Description	Register for notifications of deleted requests for the given queue `Id` . `RequestReceiver.deletedRequests()` is invoked when a `Request` is deleted or removed from this distributor.
Parameters	`osid.id.Id`	`queueId`	the Id of the queue to monitor
Errors	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRequest
Description	Registers for notification of a deleted request. `RequestReceiver.deletedRequests()` is invoked when the specified request is deleted or removed from this distributor.
Parameters	`osid.id.Id`	`requestId`	the `Id` of the `Request` to monitor
Errors	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.