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

This session defines methods to receive notifications on adds/changes to CommissionEnabler objects in this Foundry. This also includes existing CommissionEnablers 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 CommissionEnablerLookupSession.

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.
MethodcanRegisterForCommissionEnablerNotifications
Description

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

Register for notifications of new commission enablers. CommissionEnablerReceiver.newCommissionEnablers() is invoked when a new CommissionEnabler appears in this foundry.

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

Registers for notification of updated foundries. CommissionEnablerReceiver.changedCommissionEnablers() is invoked when a commission enabler in this foundry is changed.

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

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

Parametersosid.id.IdcommissionEnablerIdthe Id of the CommissionEnabler to monitor
ErrorsNULL_ARGUMENT commissionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCommissionEnablers
Description

Registers for notification of deleted commission enablers. CommissionEnablerReceiver.deletedCommissionEnablers() is invoked when a commission enabler is deleted or removed from this foundry.

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

Registers for notification of a deleted commission enabler. CommissionEnablerReceiver.deletedCommissionEnablers() is invoked when the specified commission enabler is deleted or removed from this foundry.

Parametersosid.id.IdcommissionEnablerIdthe Id of the CommissionEnabler to monitor
ErrorsNULL_ARGUMENT commissionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.