OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.FoundryNotificationSession
Implementsosid.OsidSession
Description

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

MethodcanRegisterForFoundryNotifications
Description

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

Register for notifications of new foundries. FoundryReceiver.newFoundries() is invoked when a new Foundry is created.

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

Registers for notification if an ancestor is added to the specified foundry in the foundry hierarchy. FoundryReceiver.newFoundryAncestor() is invoked when the specified foundry experiences an addition in ancestry.

Parametersosid.id.IdfoundryIdthe Id of the foundry to monitor
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewFoundryDescendants
Description

Registers for notification if a descendant is added to the specified foundry in the foundry hierarchy. FoundryReceiver.newFoundryDescendant() is invoked when the specified foundry experiences an addition in descendants.

Parametersosid.id.IdfoundryIdthe Id of the foundry to monitor
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedFoundries
Description

Registers for notification of updated foundries. FoundryReceiver.changedFoundries() is invoked when a foundry is changed.

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

Registers for notification of an updated foundry. FoundryReceiver.changedFoundries() is invoked when the specified foundry is changed.

Parametersosid.id.IdfoundryIdthe Id of the Foundry to monitor
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedFoundries
Description

Registers for notification of deleted foundries. FoundryReceiver.deletedFoundries() is invoked when a foundry is deleted.

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

Registers for notification of a deleted foundry. FoundryReceiver.deletedFoundries() is invoked when the specified foundry is deleted.

Parametersosid.id.IdfoundryIdthe Id of the Foundry to monitor
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedFoundryAncestors
Description

Registers for notification if an ancestor is removed from the specified foundry in the foundry hierarchy. FoundryReceiver.deletedFoundryAncestor() is invoked when the specified foundry experiences a removal of an ancestor.

Parametersosid.id.IdfoundryIdthe Id of the foundry to monitor
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedFoundryDescendants
Description

Registers for notification if a descendant is removed from fthe specified foundry in the foundry hierarchy. FoundryReceiver.deletedFoundryDescednant() is invoked when the specified foundry experiences a removal of one of its descdendents.

Parametersosid.id.IdfoundryIdthe Id of the foundry to monitor
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.