OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.StoreHierarchySession
Implementsosid.OsidSession
Description

This session defines methods for traversing a hierarchy of Store objects. Each node in the hierarchy is a unique Store. The hierarchy may be traversed recursively to establish the tree structure through getParentStores() and getChildStores(). To relate these Ids to another OSID, getStoreNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Store available in the Order OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

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 getParentStores() or getChildStores() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: store elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
MethodgetStoreHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetStoreHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessStoreHierarchy
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeStoreView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryStoreView
Description

A complete view of the Store returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetRootStoreIds
Description

Gets the root store Ids in this hierarchy.

Returnosid.id.IdListthe root store Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootStores
Description

Gets the root stores in the store hierarchy. A node with no parents is an orphan. While all store Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returnosid.ordering.StoreListthe root stores
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentStores
Description

Tests if the Store has any parents.

Parametersosid.id.IdstoreIda store Id
Returnboolean true if the store has parents, f alse otherwise
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfStore
Description

Tests if an Id is a direct parent of store.

Parametersosid.id.Ididan Id
osid.id.IdstoreIdthe Id of a store
Returnboolean true if this id is a parent of storeId, f alse otherwise
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT id or storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentStoreIds
Description

Gets the parent Ids of the given store.

Parametersosid.id.IdstoreIda store Id
Returnosid.id.IdListthe parent Ids of the store
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentStores
Description

Gets the parent stores of the given id.

Parametersosid.id.IdstoreIdthe Id of the Store to query
Returnosid.ordering.StoreListthe parent stores of the id
ErrorsNOT_FOUNDa Store identified by Id is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfStore
Description

Tests if an Id is an ancestor of a store.

Parametersosid.id.Ididan Id
osid.id.IdstoreIdthe Id of a store
Returnboolean tru e if this id is an ancestor of storeId, false otherwise
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT id or storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildStores
Description

Tests if a store has any children.

Parametersosid.id.IdstoreIda store Id
Returnboolean true if the storeId has children, false otherwise
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfStore
Description

Tests if a store is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdstoreIdthe Id of a store
Returnboolean true if the id is a child of storeId, false otherwise
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT id or storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildStoreIds
Description

Gets the child Ids of the given store.

Parametersosid.id.IdstoreIdthe Id to query
Returnosid.id.IdListthe children of the store
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildStores
Description

Gets the child stores of the given id.

Parametersosid.id.IdstoreIdthe Id of the Store to query
Returnosid.ordering.StoreListthe child stores of the id
ErrorsNOT_FOUNDa Store identified by Id is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfStore
Description

Tests if an Id is a descendant of a store.

Parametersosid.id.Ididan Id
osid.id.IdstoreIdthe Id of a store
Returnboolean true if the id is a descendant of the storeId, false otherwise
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT id or storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetStoreNodeIds
Description

Gets a portion of the hierarchy for the given store.

Parametersosid.id.IdstoreIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodea store node
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStoreNodes
Description

Gets a portion of the hierarchy for the given store.

Parametersosid.id.IdstoreIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.ordering.StoreNodea store node
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.