OSID Logo
OSID Specifications
inquiry rules package
Version 3.1.0
Interfaceosid.inquiry.rules.AuditConstrainerEnablerNotificationSession
Implementsosid.OsidSession
Used Byosid.inquiry.rules.InquiryRulesManager
osid.inquiry.rules.InquiryRulesProxyManager
Description

This session defines methods to receive notifications on adds/changes to AuditConstrainerEnablers in this Inquest. This also includes existing audit constrainer enablers that may appear or disappear due to changes in the Inquest hierar chy, 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 AuditConstrainerEnablerLookupSession .

MethodgetInquestId
Description

Gets the Inquest Id associated with this session.

Returnosid.id.Id the Inquest Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetInquest
Description

Gets the Inquest associated with this session.

Returnosid.inquiry.Inquest the inquest
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanRegisterForAuditConstrainerEnablerNotifications
Description

Tests if this user can register for AuditConstrainerEnabler 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
Compliancemandatory This method must be implemented.
MethoduseFederatedInquestView
Description

Federates the view for methods in this session. A federated view will include audit constrainer enablers in inquests which are children of this inquest in the inquest hierarchy.

Compliancemandatory This method is must be implemented.
MethoduseIsolatedInquestView
Description

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

Compliancemandatory This method is must be implemented.
MethodreliableAuditConstrainerEnablerNotifications
Description

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

Compliancemandatory This method is must be implemented.
MethodunreliableAuditConstrainerEnablerNotifications
Description

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

Compliancemandatory This method is must be implemented.
MethodacknowledgeAuditConstrainerEnablerNotification
Description

Acknowledge an audit constrainer enabler notification.

Parametersosid.id.IdnotificationId the Id of the notification
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForNewAuditConstrainerEnablers
Description

Register for notifications of new audit constrainer enablers. AuditConstrainerEnablerReceiver.newAuditConstrainerEnablers() is invoked when a new AuditConstrainerEnabler appears in this inquest.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAuditConstrainerEnablers
Description

Register for notifications of updated audit constrainer enablers. AuditConstrainerEnablerReceiver.changedAuditConstrainerEnablers() is invoked when an AuditConstrainerEnabler in this inquest is changed.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAuditConstrainerEnabler
Description

Register for notifications of an updated audit constrainer enabler. AuditConstrainerEnablerReceiver.changedAuditConstrainerEnablers() is invoked when the specified AuditConstrainerEnabler in this inquest is changed.

Parametersosid.id.IdauditConstrainerEnablerId the Id of the AuditConstrainerEnabler to monitor
ErrorsNULL_ARGUMENT auditConstrainerEnablerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForDeletedAuditConstrainerEnablers
Description

Registers for notification of deleted audit constrainer enablers. AuditConstrainerEnablerReceiver.deletedAuditConstrainerEnablers() is invoked when an audit constrainer enabler is deleted or removed from this inquest.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForDeletedAuditConstrainerEnabler
Description

Registers for notification of a deleted audit constrainer enabler. AuditConstrainerEnablerReceiver.deletedAuditConstrainerEnabler() is invoked when the specified audit constrainer enabler is deleted or removed from this inquest.

Parametersosid.id.IdauditConstrainerEnablerId the Id of the AuditConstrainerEnabler to monitor
ErrorsNULL_ARGUMENT auditConstrainerEnablerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.