OSID - osid.repository.RepositoryNotificationSession Service Interface Definition

Interface	osid.repository.RepositoryNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Repository` 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	canRegisterForRepositoryNotifications
Description	Tests if this user can register for `Repository` 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	registerForNewRepositories
Description	Register for notifications of new repositories. `RepositoryReceiver.newRepositories()` is invoked when a new `Repository` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRepositoryAncestors
Description	Registers for notification if an ancestor is added to the specified repository in the repository hierarchy. `RepositoryReceiver.newRepositoryAncestor()` is invoked when the specified repository experiences an addition in ancestry.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the repository to monitor
Errors	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRepositoryDescendants
Description	Registers for notification if a descendant is added to the specified repository in the repository hierarchy. `RepositoryReceiver.newRepositoryDescendant()` is invoked when the specified repository experiences an addition in descendants.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the repository to monitor
Errors	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRepositories
Description	Registers for notification of updated repositories. `RepositoryReceiver.changedRepositories()` is invoked when a repository is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRepository
Description	Registers for notification of an updated repository. `RepositoryReceiver.changedRepositories()` is invoked when the specified repository is changed.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository` to monitor
Errors	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRepositories
Description	Registers for notification of deleted repositories. `RepositoryReceiver.deletedRepositories()` is invoked when a repository is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRepository
Description	Registers for notification of a deleted repository. `RepositoryReceiver.deletedRepositories()` is invoked when the specified repository is deleted.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository` to monitor
Errors	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRepositoryAncestors
Description	Registers for notification if an ancestor is removed from the specified repository in the repository hierarchy. `RepositoryReceiver.deletedRepositoryAncestor()` is invoked when the specified repository experiences a removal of an ancestor.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the repository to monitor
Errors	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRepositoryDescendants
Description	Registers for notification if a descendant is removed from fthe specified repository in the repository hierarchy. `RepositoryReceiver.deletedRepositoryDescednant()` is invoked when the specified repository experiences a removal of one of its descdendents.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the repository to monitor
Errors	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.