OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ConfigurationHierarchySession
Implementsosid.OsidSession
Description

This session defines methods for traversing a hierarchy of Configuration objects. Each node in the hierarchy is a unique Configuration. The hierarchy may be traversed recursively to establish the tree structure through getParentConfigurations() and getChildConfigurations(). To relate these Ids to another OSID, getConfigurationNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Configuration available in the Configuration 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 getParentConfigurationss() or getChildConfigurations() 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: configuration elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
MethodgetConfigurationHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe configuration Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationHierarchy
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.
MethodcanAccessConfigurationHierarchy
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.
MethoduseComparativeConfigurationView
Description

The returns from the configuration 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.
MethodusePlenaryConfigurationView
Description

A complete view of the Configuration 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.
MethodgetRootConfigurationIds
Description

Gets the root configuration Ids in this hierarchy.

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

Gets the root configurations in the configuration hierarchy. A node with no parents is an orphan. While all configuration 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.configuration.ConfigurationListthe root configurations
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentConfigurations
Description

Tests if the Configuration has any parents.

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

Tests if an Id is a direct parent of configuration.

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

If id not found return false.

MethodgetParentConfigurationIds
Description

Gets the parent Ids of the given configuration.

Parametersosid.id.IdconfigurationIda configuration Id
Returnosid.id.IdListthe parent Ids of the configuration
ErrorsNOT_FOUND configurationId is not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentConfigurations
Description

Gets the parents of the given configuration.

Parametersosid.id.IdconfigurationIdthe Id to query
Returnosid.configuration.ConfigurationListthe parents of the configuration
ErrorsNOT_FOUND configurationId not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfConfiguration
Description

Tests if an Id is an ancestor of a configuration.

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

If id not found return false.

MethodhasChildConfigurations
Description

Tests if a configuration has any children.

Parametersosid.id.IdconfigurationIda configurationId
Returnboolean true if the configurationId has children, false otherwise
ErrorsNOT_FOUND configurationId not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfConfiguration
Description

Tests if a node is a direct child of another.

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

If id not found return false.

MethodgetChildConfigurationIds
Description

Gets the child Ids of the given configuration.

Parametersosid.id.IdconfigurationIdthe Id to query
Returnosid.id.IdListthe children of the configuration
ErrorsNOT_FOUND configurationId is not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildConfigurations
Description

Gets the children of the given configuration.

Parametersosid.id.IdconfigurationIdthe Id to query
Returnosid.configuration.ConfigurationListthe children of the configuration
ErrorsNOT_FOUND configurationId not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfConfiguration
Description

Tests if an Id is a descendant of a configuration.

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

If id is not found return false.

MethodgetConfigurationNodeIds
Description

Gets a portion of the hierarchy for the given configuration.

Parametersosid.id.IdconfigurationIdthe 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 configuration node
ErrorsNOT_FOUND configurationId not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationNodes
Description

Gets a portion of the hierarchy for the given configuration.

Parametersosid.id.IdconfigurationIdthe 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.configuration.ConfigurationNodea configuration node
ErrorsNOT_FOUND configurationId not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.