Interface | osid.workflow.OfficeNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForOfficeNotifications | ||
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 | registerForNewOffices | ||
Description |
Register for notifications of new offices. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewOfficeAncestors | ||
Description |
Registers for notification if an ancestor is added to
the specified office in the office hierarchy. | ||
Parameters | osid.id.Id | officeId | the Id of the office to monitor |
Errors | NULL_ARGUMENT | officeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewOfficeDescendants | ||
Description |
Registers for notification if a descendant is added to
the specified office in the office hierarchy. | ||
Parameters | osid.id.Id | officeId | the Id of the office to monitor |
Errors | NULL_ARGUMENT | officeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOffices | ||
Description |
Registers for notification of updated offices. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOffice | ||
Description |
Registers for notification of an updated office. | ||
Parameters | osid.id.Id | officeId | the Id of the Office to monitor |
Errors | NULL_ARGUMENT | officeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOffices | ||
Description |
Registers for notification of deleted offices. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOffice | ||
Description |
Registers for notification of a deleted office. | ||
Parameters | osid.id.Id | officeId | the Id of the Office to monitor |
Errors | NULL_ARGUMENT | officeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOfficeAncestors | ||
Description |
Registers for notification if an ancestor is removed
from the specified office in the office hierarchy. | ||
Parameters | osid.id.Id | officeId | the Id of the office to monitor |
Errors | NULL_ARGUMENT | officeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOfficeDescendants | ||
Description |
Registers for notification if a descendant is removed
from fthe specified office in the office hierarchy. | ||
Parameters | osid.id.Id | officeId | the Id of the office to monitor |
Errors | NULL_ARGUMENT | officeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |