OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CatalogueNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Catalogue 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.

Notifications are triggered with changes to the Catalogue object itself. Adding and removing canonical units result in notifications available from the notification session for canonical units.

MethodcanRegisterForCatalogueNotifications
Description

Tests if this user can register for Catalogue 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCatalogues
Description

Register for notifications of new catalogues. CatalogueReceiver.newCatalogues() is invoked when a new Catalogue is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCatalogueAncestors
Description

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified catalogue. CatalogueReceiver.newAncestorCatalogue() is invoked when the specified catalogue node gets a new ancestor.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue node to monitor
ErrorsNULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCatalogueDescendants
Description

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified catalogue. CatalogueReceiver.newDescendantCatalogue() is invoked when the specified catalogue node gets a new descendant.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue node to monitor
ErrorsNULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCatalogues
Description

Registers for notification of updated catalogues. CatalogueReceiver.changedCatalogues() is invoked when a catalogue is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCatalogue
Description

Registers for notification of an updated catalogue. CatalogueReceiver.changedCatalogues() is invoked when the specified catalogue is changed.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue to monitor
ErrorsNULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCatalogues
Description

Registers for notification of deleted catalogues. CatalogueReceiver.deletedCatalogues() is invoked when a catalogue is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCatalogue
Description

Registers for notification of a deleted catalogue. CatalogueReceiver.deletedCatalogues() is invoked when the specified catalogue is deleted.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue to monitor
ErrorsNULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCatalogueAncestors
Description

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified catalogue CatalogueReceiver.deletedAncestor() is invoked when the specified catalogue node loses an ancestor.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue to monitor
ErrorsNULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCatalogueDescendants
Description

Registers for notification of an updated hierarchy structure that removes a descendant of the specified catalogue. CatalogueReceiver.deletedDescendant() is invoked when the specified catalogue node loses a descendant.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue to monitor
ErrorsNULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.