Interface | osid.ordering.StoreHierarchySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for traversing a hierarchy of
A user may not be authorized to traverse the entire
hierarchy. Parts of the hierarchy may be made invisible
through omission from the returns of This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
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 | canAccessStoreHierarchy | ||
Description |
Tests if this user can perform hierarchy queries. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a | ||
Return | boolean | false if hierarchy traversal methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeStoreView | ||
Description |
The returns from the store methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryStoreView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootStoreIds | ||
Description |
Gets the root store | ||
Return | osid.id.IdList | the root store Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootStores | ||
Description |
Gets the root stores in the store hierarchy. A node
with no parents is an orphan. While all store | ||
Return | osid.ordering.StoreList | the root stores | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentStores | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | storeId | a store Id |
Return | boolean | true if the store has parents, f alse
otherwise | |
Errors | 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 | isParentOfStore | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | storeId | the Id of a store | |
Return | boolean | true if this id is a parent of
storeId, f alse otherwise | |
Errors | NOT_FOUND | storeId is not found | |
NULL_ARGUMENT | id or storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentStoreIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | storeId | a store Id |
Return | osid.id.IdList | the parent Ids of the store | |
Errors | 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 | getParentStores | ||
Description |
Gets the parent stores of the given | ||
Parameters | osid.id.Id | storeId | the Id of the Store to query |
Return | osid.ordering.StoreList | the parent stores of the id | |
Errors | NOT_FOUND | a Store identified by Id 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 | isAncestorOfStore | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | storeId | the Id of a store | |
Return | boolean | tru e if this id is an ancestor of
storeId, false otherwise | |
Errors | NOT_FOUND | storeId is not found | |
NULL_ARGUMENT | id or storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildStores | ||
Description |
Tests if a store has any children. | ||
Parameters | osid.id.Id | storeId | a store Id |
Return | boolean | true if the storeId has children,
false otherwise | |
Errors | 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 | isChildOfStore | ||
Description |
Tests if a store is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | storeId | the Id of a store | |
Return | boolean | true if the id is a child of storeId,
false otherwise | |
Errors | NOT_FOUND | storeId is not found | |
NULL_ARGUMENT | id or storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildStoreIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | storeId | the Id to query |
Return | osid.id.IdList | the children of the store | |
Errors | 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 | getChildStores | ||
Description |
Gets the child stores of the given | ||
Parameters | osid.id.Id | storeId | the Id of the Store to query |
Return | osid.ordering.StoreList | the child stores of the id | |
Errors | NOT_FOUND | a Store identified by Id 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 | isDescendantOfStore | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | storeId | the Id of a store | |
Return | boolean | true if the id is a descendant of the
storeId, false otherwise | |
Errors | NOT_FOUND | storeId is not found | |
NULL_ARGUMENT | id or storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getStoreNodeIds | ||
Description |
Gets a portion of the hierarchy for the given store. | ||
Parameters | osid.id.Id | storeId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.hierarchy.Node | a store node | |
Errors | 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 | getStoreNodes | ||
Description |
Gets a portion of the hierarchy for the given store. | ||
Parameters | osid.id.Id | storeId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.ordering.StoreNode | a store node | |
Errors | 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. |