OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.FrontOfficeNotificationSession
Implementsosid.OsidSession
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
CompliancemandatoryThis method must be implemented.
MethodregisterForNewFrontOffices
Description

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

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

Registers for notification if an ancestor is added to the specified front office in the front office hierarchy. FrontOfficeReceiver.newFrontOfficeAncestor() is invoked when the specified front office experiences an addition in ancestry.

Parametersosid.id.IdfrontOfficeIdthe Id of the front office to monitor
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewFrontOfficeDescendants
Description

Registers for notification if a descendant is added to the specified front office in the front office hierarchy. FrontOfficeReceiver.newFrontOfficeDescendant() is invoked when the specified front office experiences an addition in descendants.

Parametersosid.id.IdfrontOfficeIdthe Id of the front office to monitor
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedFrontOffices
Description

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

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis 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.IdfrontOfficeIdthe Id of the FrontOffice to monitor
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedFrontOffices
Description

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

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis 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.IdfrontOfficeIdthe Id of the FrontOffice to monitor
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedFrontOfficeAncestors
Description

Registers for notification if an ancestor is removed from the specified front office in the front office hierarchy. FrontOfficeReceiver.deletedFrontOfficeAncestor() is invoked when the specified front office experiences a removal of an ancestor.

Parametersosid.id.IdfrontOfficeIdthe Id of the front office to monitor
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedFrontOfficeDescendants
Description

Registers for notification if a descendant is removed from fthe specified front office in the front office hierarchy. FrontOfficeReceiver.deletedFrontOfficeDescednant() is invoked when the specified front office experiences a removal of one of its descdendents.

Parametersosid.id.IdfrontOfficeIdthe Id of the front office to monitor
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.