OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.QualifierNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Qualifier objects in this Vault. 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 QualifierLookupSession.

MethodgetVaultId
Description

Gets the Vault Id associated with this session.

Returnosid.id.Idthe Vault Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetVault
Description

Gets the Vault associated with this session.

Returnosid.authorization.Vaultthe Vault associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForQualifierNotifications
Description

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

Federates the view for methods in this session. A federated view will include notifications for qualifiers in vaults which are children of this vault in the vault hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedVaultView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableQualifierNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableQualifierNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeQualifierNotification
Description

Acknowledge a qualifier notification.

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

Register for notifications of new qualifiers. QualifierReceiver.newQualifiers() is invoked when a new Qualifier is created.

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

Registers for notification of updated qualifiers. QualifierReceiver.changedQualifiers() is invoked when a qualifier is changed.

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

Registers for notification of an updated qualifier. QualifierReceiver.changedQualifiers() is invoked when the specified qualifier is changed.

Parametersosid.id.IdqualifierIdthe Id of the Qualifier to monitor
ErrorsNULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedQualifiers
Description

Registers for notification of deleted qualifiers. QualifierReceiver.deletedQualifiers() is invoked when a qualifier is removed from this vault.

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

Registers for notification of a deleted qualifier. QualifierReceiver.deletedQualifiers() is invoked when the specified qualifier is removed from this vault.

Parametersosid.id.IdqualifierIdthe Id of the Qualifier to monitor
ErrorsNULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedQualifierHierarchy
Description

Registers for notification of an updated qualifier hierarchy structure. QualifierReceiver.changedChildOfQualfiers() is invoked when a node experiences a change in its children.

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

Registers for notification of an updated qualifier hierarchy structure. QualifierReceiver.changedChildOfQualifiers() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdqualifierIdthe Id of the Qualifier node to monitor
ErrorsNULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedQualifierHierarchyForDescendants
Description

Registers for notification of an updated qualifier hierarchy structure. QualifierReceiver.changedChildOfQualifiers() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdqualifierIdthe Id of the Qualifier node to monitor
ErrorsNULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.