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

This session defines methods for managing a hierarchy of Map objects. Each node in the hierarchy is a unique Map.

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.
MethodcanModifyMapHierarchy
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.
MethodaddRootMap
Description

Adds a root map.

Parametersosid.id.IdmapIdthe Id of a map
ErrorsALREADY_EXISTS mapId is already in hierarchy
NOT_FOUND mapId not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootMap
Description

Removes a root map.

Parametersosid.id.IdmapIdthe Id of a map
ErrorsNOT_FOUND mapId is not a root
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildMap
Description

Adds a child to a map.

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

Removes a child from a map.

Parametersosid.id.IdmapIdthe Id of a map
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND mapId is not parent of childId
NULL_ARGUMENT mapId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildMaps
Description

Removes all children from a map.

Parametersosid.id.IdmapIdthe Id of a 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.