OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.MapHierarchySession
Implementsosid.OsidSession
Description

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

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 getParentMaps() or getChildMaps() 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 map view: map elements may be silently omitted or re-ordered
  • plenary map view: provides a complete set or is an error condition
MethodgetMapHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

The returns from the map 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.
MethodusePlenaryMapView
Description

A complete view of the Maps 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.
MethodgetRootMapIds
Description

Gets the root map Ids in this hierarchy.

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

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

Returnosid.mapping.MapListthe root maps
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentMaps
Description

Tests if the Map has any parents.

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

Tests if an Id is a direct parent of map.

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

If id not found return false.

MethodgetParentMapIds
Description

Gets the parent Ids of the given map.

Parametersosid.id.IdmapIda map Id
Returnosid.id.IdListthe parent Ids of the map
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentMaps
Description

Gets the parents of the given map.

Parametersosid.id.IdmapIdthe Id to query
Returnosid.mapping.MapListthe parents of the map
ErrorsNOT_FOUND mapId not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfMap
Description

Tests if an Id is an ancestor of a map.

Parametersosid.id.Ididan Id
osid.id.IdmapIdthe Id of a map
Returnboolean tru e if this id is an ancestor of mapId, false otherwise
ErrorsNOT_FOUND mapId not found
NULL_ARGUMENT mapId 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.

MethodhasChildMaps
Description

Tests if a map has any children.

Parametersosid.id.IdmapIda map Id
Returnboolean true if the mapId has children, false otherwise
ErrorsNOT_FOUND mapId not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfMap
Description

Tests if a map is a direct child of another.

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

If id not found return false.

MethodgetChildMapIds
Description

Gets the child Ids of the given map.

Parametersosid.id.IdmapIdthe Id to query
Returnosid.id.IdListthe children of the map
ErrorsNOT_FOUND mapId not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildMaps
Description

Gets the children of the given map.

Parametersosid.id.IdmapIdthe Id to query
Returnosid.mapping.MapListthe children of the map
ErrorsNOT_FOUND mapId not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfMap
Description

Tests if an Id is a descendant of a map.

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

If id is not found return false.

MethodgetMapNodeIds
Description

Gets a portion of the hierarchy for the given map.

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

Gets a portion of the hierarchy for the given map.

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