OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ParameterProcessorEnablerNotificationSession
Implementsosid.OsidSession
Description

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

MethodgetConfigurationId
Description

Gets the Configuration Id associated with this session.

Returnosid.id.Idthe Configuration Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetConfiguration
Description

Gets the Configuration associated with this session.

Returnosid.configuration.Configurationthe configuration
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForParameterProcessorEnablerNotifications
Description

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

Federates the view for methods in this session. A federated view will include enablers in configurations which are children of this configuration in the configuration hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedConfigurationView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableParameterProcessorEnablerNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeParameterProcessorEnablerNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableParameterProcessorEnablerNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeParameterProcessorEnablerNotification
Description

Acknowledge a parameter processor enabler notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewParameterProcessorEnablers
Description

Register for notifications of new parameter processor enablers. ParameterProcessorEnablerReceiver.newParameterProcessorEnablers() is invoked when a new ParameterProcessorEnabler appears in this configuration.

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

Registers for notification of updated parameter processor enablers. ParameterProcessorEnablerReceiver.changedParameterProcessorEnablers() is invoked when a parameter processor enabler in this configuration is changed.

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

Registers for notification of an updated parameter processor enabler. ProvisionableReceiver.changedParameterProcessorEnablers() is invoked when the specified parameter processor enabler in this configuration is changed.

Parametersosid.id.IdparameterProcessorEnablerProcessorIdthe Id of the ParameterProcessorEnabler to monitor
ErrorsNULL_ARGUMENT parameterProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedParameterProcessorEnablers
Description

Registers for notification of deleted parameter processor enablers. ParameterProcessorEnablerReceiver.deletedParameterProcessorEnablers() is invoked when a parameter processor enabler is deleted or removed from this configuration.

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

Registers for notification of a deleted parameter processor enabler. ParameterProcessorEnablerReceiver.deletedParameterProcessorEnablers() is invoked when the specified parameter processor enabler is deleted or removed from this configuration.

Parametersosid.id.IdparameterProcessorEnablerIdthe Id of the ParameterProcessorEnabler to monitor
ErrorsNULL_ARGUMENT parameterProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.