Interface | osid.ordering.StoreHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages a hierarchy of stores. Stores may be
organized into a hierarchy for organizing or federating. A
parent | ||
Method | getStoreHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getStoreHierarchy | ||
Description |
Gets the hierarchy associated with this session. | ||
Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canModifyStoreHierarchy | ||
Description |
Tests if this user can change the hierarchy. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known performing any
update will result in a | ||
Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | addRootStore | ||
Description |
Adds a root store. | ||
Parameters | osid.id.Id | storeId | the Id of a store |
Errors | ALREADY_EXISTS | storeId is already in hierarchy | |
NOT_FOUND | storeId is not found | ||
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootStore | ||
Description |
Removes a root store. | ||
Parameters | osid.id.Id | storeId | the Id of a store |
Errors | NOT_FOUND | storeId is not a root | |
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildStore | ||
Description |
Adds a child to a store. | ||
Parameters | osid.id.Id | storeId | the Id of a store |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | storeId is already a parent of childId | |
NOT_FOUND | storeId or childId not found | ||
NULL_ARGUMENT | storeId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildStore | ||
Description |
Removes a child from a store. | ||
Parameters | osid.id.Id | storeId | the Id of a store |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | storeId not a parent of childId | |
NULL_ARGUMENT | storeId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildStores | ||
Description |
Removes all children from a store. | ||
Parameters | osid.id.Id | storeId | the Id of a store |
Errors | NOT_FOUND | storeId not found | |
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |