OSID Logo
OSID Specifications
tracking package
Version 3.1.0
Interfaceosid.tracking.FrontOfficeNotificationSession
Implementsosid.OsidSession
Used Byosid.tracking.TrackingManager
osid.tracking.TrackingProxyManager
Description

This session defines methods to receive notifications on adds/changes to FrontOffice objects. 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.

MethodcanRegisterForFrontOfficeNotifications
Description

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

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

Compliancemandatory This method is must be implemented.
MethodunreliableFrontOfficeNotifications
Description

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

Compliancemandatory This method is must be implemented.
MethodacknowledgeFrontOfficeNotification
Description

Acknowledge a front office 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.
MethodregisterForNewFrontOffices
Description

Register for notifications of new frontOffices. FrontOfficeReceiver.newFrontOffices() is invoked when a new FrontOffice is created.

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

Registers for notification of updated frontOffices. FrontOfficeReceiver.changedFrontOffices() is invoked when a front office is changed.

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

Registers for notification of an updated front office. FrontOfficeReceiver.changedFrontOffices() is invoked when the specified front office is changed.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice to monitor
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForDeletedFrontOffices
Description

Registers for notification of deleted frontOffices. FrontOfficeReceiver.deletedFrontOffices() is invoked when a front office is deleted.

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

Registers for notification of a deleted front office. FrontOfficeReceiver.deletedFrontOffices() is invoked when the specified front office is deleted.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice to monitor
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedFrontOfficeHierarchy
Description

Registers for notification of an updated front office hierarchy structure. FrontOfficeReceiver.changedChildOfFrontOffices() is invoked when the specified node or any of its descendants experiences a change in its children.

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

Registers for notification of an updated front office hierarchy structure. FrontOfficeReceiver.changedChildOfFrontOffices() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice node to monitor
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedFrontOfficeHierarchyForDescendants
Description

Registers for notification of an updated front office hierarchy structure. FrontOfficeReceiver.changedChildOfFrontOffices() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice node to monitor
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.