OSID - osid.transport.EndpointNotificationSession Service Interface Definition

Interface	osid.transport.EndpointNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.transport.TransportManager`
Used By	`osid.transport.TransportProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Endpoint` objects. 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.
Method	canRegisterForEndpointNotifications
Description	Tests if this user can register for `Endpoint` 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	reliableEndpointNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeEndpointNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableEndpointNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeEndpointNotification
Description	Acknowledge a endpoint 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	registerForNewEndpoints
Description	Register for notifications of new endpoints. `EndpointReceiver.newEndpoints()` is invoked when a new `Endpoint` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEndpoints
Description	Registers for notification of updated endpoints. `EndpointReceiver.changedEndpoints()` is invoked when a endpoint is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEndpoint
Description	Registers for notification of an updated endpoint. `EndpointReceiver.changedEndpoints()` is invoked when the specified endpoint is changed.
Parameters	`osid.id.Id`	`endpointId`	the Id of the Endpoint to monitor
Errors	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEndpoints
Description	Registers for notification of deleted endpoints. `EndpointReceiver.deletedEndpoints()` is invoked when a endpoint is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEndpoint
Description	Registers for notification of a deleted endpoint. `EndpointReceiver.deletedEndpoints()` is invoked when the specified endpoint is deleted.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of the `Endpoint` to monitor
Errors	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEndpointHierarchy
Description	Registers for notification of an updated endpoint hierarchy structure. `EndpointReceiver.changedChildOfEndpoints()` is invoked when the specified node or any of its descendants experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEndpointHierarchyForAncestors
Description	Registers for notification of an updated endpoint hierarchy structure. `EndpointReceiver.changedChildOfEndpoints()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of the `Endpoint` node to monitor
Errors	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEndpointHierarchyForDescendants
Description	Registers for notification of an updated endpoint hierarchy structure. `EndpointReceiver.changedChildOfEndpoints()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of the `Endpoint` node to monitor
Errors	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.