OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.OfficeNotificationSession
Implementsosid.OsidSession
Description

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

MethodcanRegisterForOfficeNotifications
Description

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

Register for notifications of new offices. OfficeReceiver.newOffices() is invoked when a new Office is created.

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

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

Parametersosid.id.IdofficeIdthe Id of the office to monitor
ErrorsNULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewOfficeDescendants
Description

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

Parametersosid.id.IdofficeIdthe Id of the office to monitor
ErrorsNULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOffices
Description

Registers for notification of updated offices. OfficeReceiver.changedOffices() is invoked when an office is changed.

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

Registers for notification of an updated office. OfficeReceiver.changedOffices() is invoked when the specified office is changed.

Parametersosid.id.IdofficeIdthe Id of the Office to monitor
ErrorsNULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOffices
Description

Registers for notification of deleted offices. OfficeReceiver.deletedOffices() is invoked when an office is deleted.

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

Registers for notification of a deleted office. OfficeReceiver.deletedOffices() is invoked when the specified office is deleted.

Parametersosid.id.IdofficeIdthe Id of the Office to monitor
ErrorsNULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOfficeAncestors
Description

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

Parametersosid.id.IdofficeIdthe Id of the office to monitor
ErrorsNULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOfficeDescendants
Description

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

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