Interface | osid.resourcing.FoundryNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForFoundryNotifications | ||
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 | registerForNewFoundries | ||
Description |
Register for notifications of new foundries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewFoundryAncestors | ||
Description |
Registers for notification if an ancestor is added to
the specified foundry in the foundry hierarchy. | ||
Parameters | osid.id.Id | foundryId | the Id of the foundry to monitor |
Errors | NULL_ARGUMENT | foundryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewFoundryDescendants | ||
Description |
Registers for notification if a descendant is added to
the specified foundry in the foundry hierarchy. | ||
Parameters | osid.id.Id | foundryId | the Id of the foundry to monitor |
Errors | NULL_ARGUMENT | foundryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedFoundries | ||
Description |
Registers for notification of updated foundries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedFoundry | ||
Description |
Registers for notification of an updated foundry.
| ||
Parameters | osid.id.Id | foundryId | the Id of the Foundry to monitor |
Errors | NULL_ARGUMENT | foundryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFoundries | ||
Description |
Registers for notification of deleted foundries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFoundry | ||
Description |
Registers for notification of a deleted foundry. | ||
Parameters | osid.id.Id | foundryId | the Id of the Foundry to monitor |
Errors | NULL_ARGUMENT | foundryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFoundryAncestors | ||
Description |
Registers for notification if an ancestor is removed
from the specified foundry in the foundry hierarchy.
| ||
Parameters | osid.id.Id | foundryId | the Id of the foundry to monitor |
Errors | NULL_ARGUMENT | foundryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFoundryDescendants | ||
Description |
Registers for notification if a descendant is removed
from fthe specified foundry in the foundry hierarchy.
| ||
Parameters | osid.id.Id | foundryId | the Id of the foundry to monitor |
Errors | NULL_ARGUMENT | foundryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |