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

This session manages a hierarchy of stores. Stores may be organized into a hierarchy for organizing or federating. A parent Store includes all of the orders of its children such that a single root node contains all of the orders of the federation.

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.
MethodcanModifyStoreHierarchy
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootStore
Description

Adds a root store.

Parametersosid.id.IdstoreIdthe Id of a store
ErrorsALREADY_EXISTS storeId is already in hierarchy
NOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootStore
Description

Removes a root store.

Parametersosid.id.IdstoreIdthe Id of a store
ErrorsNOT_FOUND storeId is not a root
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildStore
Description

Adds a child to a store.

Parametersosid.id.IdstoreIdthe Id of a store
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS storeId is already a parent of childId
NOT_FOUND storeId or childId not found
NULL_ARGUMENT storeId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildStore
Description

Removes a child from a store.

Parametersosid.id.IdstoreIdthe Id of a store
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND storeId not a parent of childId
NULL_ARGUMENT storeId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildStores
Description

Removes all children from a store.

Parametersosid.id.IdstoreIdthe Id of a store
ErrorsNOT_FOUND storeId not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.