Interface | osid.tracking.FrontOfficeNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForFrontOfficeNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewFrontOffices | ||
Description |
Register for notifications of new frontOffices. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewFrontOfficeAncestors | ||
Description |
Registers for notification if an ancestor is added to
the specified front office in the front office hierarchy.
| ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office to monitor |
Errors | NULL_ARGUMENT | frontOfficeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewFrontOfficeDescendants | ||
Description |
Registers for notification if a descendant is added to
the specified front office in the front office hierarchy.
| ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office to monitor |
Errors | NULL_ARGUMENT | frontOfficeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedFrontOffices | ||
Description |
Registers for notification of updated frontOffices.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedFrontOffice | ||
Description |
Registers for notification of an updated front office.
| ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice to monitor |
Errors | NULL_ARGUMENT | frontOfficeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFrontOffices | ||
Description |
Registers for notification of deleted frontOffices.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFrontOffice | ||
Description |
Registers for notification of a deleted front office.
| ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice to monitor |
Errors | NULL_ARGUMENT | frontOfficeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFrontOfficeAncestors | ||
Description |
Registers for notification if an ancestor is removed
from the specified front office in the front office
hierarchy. | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office to monitor |
Errors | NULL_ARGUMENT | frontOfficeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFrontOfficeDescendants | ||
Description |
Registers for notification if a descendant is removed
from fthe specified front office in the front office
hierarchy. | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office to monitor |
Errors | NULL_ARGUMENT | frontOfficeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |