Interface | osid.ordering.StoreNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | canRegisterForStoreNotifications | ||
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 | registerForNewStores | ||
Description |
Register for notifications of new stores. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewStoreAncestors | ||
Description |
Registers for notification of an updated hierarchy
structure that introduces a new ancestor of the specified
store. | ||
Parameters | osid.id.Id | storeId | the Id of the Store node to monitor |
Errors | NULL_ARGUMENT | storeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewStoreDescendants | ||
Description |
Registers for notification of an updated hierarchy
structure that introduces a new descendant of the
specified store. | ||
Parameters | osid.id.Id | storeId | the Id of the Store node to monitor |
Errors | NULL_ARGUMENT | storeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedStores | ||
Description |
Registers for notification of updated stores. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedStore | ||
Description |
Registers for notification of an updated store. | ||
Parameters | osid.id.Id | storeId | the Id of the Store to monitor |
Errors | NULL_ARGUMENT | storeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedStores | ||
Description |
Registers for notification of deleted stores. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedStore | ||
Description |
Registers for notification of a deleted store. | ||
Parameters | osid.id.Id | storeId | the Id of the Store to monitor |
Errors | NULL_ARGUMENT | storeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedStoreAncestors | ||
Description |
Registers for notification of an updated hierarchy
structure that removes an ancestor of the specified store
| ||
Parameters | osid.id.Id | storeId | the Id of the Store to monitor |
Errors | NULL_ARGUMENT | storeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedStoreDescendants | ||
Description |
Registers for notification of an updated hierarchy
structure that removes a descendant of the specified
store. | ||
Parameters | osid.id.Id | storeId | the Id of the Store to monitor |
Errors | NULL_ARGUMENT | storeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |