OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.QualifierHierarchySession
Implementsosid.OsidSession
Description

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

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetQualifierHierarchy
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.
MethodcanAccessQualifierHierarchy
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.
MethoduseComparativeQualifierView
Description

The returns from the qualifier 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.
MethodusePlenaryQualifierView
Description

A complete view of the Hierarchy 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.
MethodgetRootQualifierIds
Description

Gets the root qualifier Ids in this hierarchy.

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

Gets the root qualifiers in this qualifier hierarchy.

Returnosid.authorization.QualifierListthe root qualifiers
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentQualifiers
Description

Tests if the Qualifier has any parents.

Parametersosid.id.IdqualifierIda qualifier Id
Returnboolean true if the qualifier has parents, false otherwise
ErrorsNOT_FOUND qualifierId is not found
NULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfQualifier
Description

Tests if an Id is a direct parent of qualifier.

Parametersosid.id.Ididan Id
osid.id.IdqualifierIdthe Id of a qualifier
Returnboolean true if this id is a parent of qualifierId, false otherwise
ErrorsNOT_FOUND qualifierId is not found
NULL_ARGUMENT id or qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentQualifierIds
Description

Gets the parent Ids of the given qualifier.

Parametersosid.id.IdqualifierIda qualifier Id
Returnosid.id.IdListthe parent Ids of the qualifier
ErrorsNOT_FOUND qualifierId is not found
NULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentQualifiers
Description

Gets the parents of the given qualifier.

Parametersosid.id.IdqualifierIda qualifier Id
Returnosid.authorization.QualifierListthe parents of the qualifier
ErrorsNOT_FOUND qualifierId is not found
NULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfQualifier
Description

Tests if an Id is an ancestor of a qualifier.

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

If id not found return false.

MethodhasChildQualifiers
Description

Tests if a qualifier has any children.

Parametersosid.id.IdqualifierIda qualifier Id
Returnboolean true if the qualifierId has children, false otherwise
ErrorsNOT_FOUND qualifierId not found
NULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfQualifier
Description

Tests if a node is a direct child of another.

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

If id not found return false.

MethodgetChildQualifierIds
Description

Gets the child Ids of the given qualifier.

Parametersosid.id.IdqualifierIdthe Id to query
Returnosid.id.IdListthe children of the qualifier
ErrorsNOT_FOUND qualifierId is not found
NULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildQualifiers
Description

Gets the children of the given qualifier.

Parametersosid.id.IdqualifierIdthe Id to query
Returnosid.authorization.QualifierListthe children of the qualifier
ErrorsNOT_FOUND qualifierId is not found
NULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfQualifier
Description

Tests if an Id is a descendant of a qualifier.

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

If id is not found return false.

MethodgetQualifierNodeIds
Description

Gets a portion of the hierarchy for the given qualifier.

Parametersosid.id.IdqualifierIdthe 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 qualifier node
ErrorsNOT_FOUND functionId is not found
NULL_ARGUMENT functionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQualifierNodes
Description

Gets a portion of the hierarchy for the given qualifier.

Parametersosid.id.IdqualifierIdthe 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.authorization.QualifierNodea qualifier node
ErrorsNOT_FOUND functionId is not found
NULL_ARGUMENT functionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.