Interface | osid.mapping.MapHierarchySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for traversing a hierarchy of
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 This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | getMapHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMapHierarchy | ||
Description |
Gets the hierarchy associated with this session. | ||
Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAccessMapHierarchy | ||
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 | ||
Return | boolean | false if hierarchy traversal methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeMapView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryMapView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootMapIds | ||
Description |
Gets the root map | ||
Return | osid.id.IdList | the root map Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootMaps | ||
Description |
Gets the root map in the map hierarchy. A location with
no parents is an orphan. While all map | ||
Return | osid.mapping.MapList | the root maps | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentMaps | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | mapId | a map Id |
Return | boolean | true if the map has parents, f alse otherwise | |
Errors | NOT_FOUND | mapId is not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isParentOfMap | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | mapId | the Id of a map | |
Return | boolean | true if this id is a parent of mapId,
f alse otherwise | |
Errors | NOT_FOUND | mapId is not found | |
NULL_ARGUMENT | id or mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentMapIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | mapId | a map Id |
Return | osid.id.IdList | the parent Ids of the map | |
Errors | NOT_FOUND | mapId is not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParentMaps | ||
Description |
Gets the parents of the given map. | ||
Parameters | osid.id.Id | mapId | the Id to query |
Return | osid.mapping.MapList | the parents of the map | |
Errors | NOT_FOUND | mapId not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isAncestorOfMap | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | mapId | the Id of a map | |
Return | boolean | tru e if this id is an ancestor of
mapId, false otherwise | |
Errors | NOT_FOUND | mapId not found | |
NULL_ARGUMENT | mapId or id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildMaps | ||
Description |
Tests if a map has any children. | ||
Parameters | osid.id.Id | mapId | a map Id |
Return | boolean | true if the mapId has children, false
otherwise | |
Errors | NOT_FOUND | mapId not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isChildOfMap | ||
Description |
Tests if a map is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | mapId | the Id of a map | |
Return | boolean | true if the id is a child of mapId,
false otherwise | |
Errors | NOT_FOUND | mapId not found | |
NULL_ARGUMENT | id or mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildMapIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | mapId | the Id to query |
Return | osid.id.IdList | the children of the map | |
Errors | NOT_FOUND | mapId not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChildMaps | ||
Description |
Gets the children of the given map. | ||
Parameters | osid.id.Id | mapId | the Id to query |
Return | osid.mapping.MapList | the children of the map | |
Errors | NOT_FOUND | mapId not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isDescendantOfMap | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | mapId | the Id of a map | |
Return | boolean | true if the id is a descendant of the
mapId, false otherwise | |
Errors | NOT_FOUND | mapId not found | |
NULL_ARGUMENT | id or mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getMapNodeIds | ||
Description |
Gets a portion of the hierarchy for the given map. | ||
Parameters | osid.id.Id | mapId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the location. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the location. | |
boolean | includeSiblings | true to include the siblings of the given location,
false to omit the siblings | |
Return | osid.hierarchy.Node | a map node | |
Errors | NOT_FOUND | mapId not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMapNodes | ||
Description |
Gets a portion of the hierarchy for the given map. | ||
Parameters | osid.id.Id | mapId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the location. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the location. | |
boolean | includeSiblings | true to include the siblings of the given location,
false to omit the siblings | |
Return | osid.mapping.MapNode | a map node | |
Errors | NOT_FOUND | mapId not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |