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

This session defines methods to receive notifications on adds/changes to AvailabilityEnabler objects in this Foundry. This also includes existing AvailabilityEnablers that may appear or disappear due to changes in the Foundry 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 AvailabilityEnablerLookupSession.

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForAvailabilityEnablerNotifications
Description

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

Federates the view for methods in this session. A federated view will include in foundries which are children of this foundry in the foundry hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFoundryView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this foundry only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewAvailabilityEnablers
Description

Register for notifications of new availability enablers. AvailabilityEnablerReceiver.newAvailabilityEnablers() is invoked when a new AvailabilityEnabler appears in this foundry.

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

Registers for notification of updated foundries. AvailabilityEnablerReceiver.changedAvailabilityEnablers() is invoked when an availability enabler in this foundry is changed.

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

Registers for notification of an updated availability enabler. ProvisionableReceiver.changedAvailabilityEnablers() is invoked when the specified availability enabler in this foundry is changed.

Parametersosid.id.IdavailabilityEnablerIdthe Id of the AvailabilityEnabler to monitor
ErrorsNULL_ARGUMENT availabilityEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAvailabilityEnablers
Description

Registers for notification of deleted availability enablers. AvailabilityEnablerReceiver.deletedAvailabilityEnablers() is invoked when an availability enabler is deleted or removed from this foundry.

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

Registers for notification of a deleted availability enabler. AvailabilityEnablerReceiver.deletedAvailabilityEnablers() is invoked when the specified availability enabler is deleted or removed from this foundry.

Parametersosid.id.IdavailabilityEnablerIdthe Id of the AvailabilityEnabler to monitor
ErrorsNULL_ARGUMENT availabilityEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.