OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.InquestHierarchyDesignSession
Implementsosid.OsidSession
Description

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

MethodgetInquestHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

Adds a root inquest.

Parametersosid.id.IdinquestIdthe Id of an inquest
ErrorsALREADY_EXISTS inquestId is already in hierarchy
NOT_FOUND inquestId not found
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootInquest
Description

Removes a root inquest.

Parametersosid.id.IdinquestIdthe Id of an inquest
ErrorsNOT_FOUND inquestId is not a root
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildInquest
Description

Adds a child to an inquest.

Parametersosid.id.IdinquestIdthe Id of an inquest
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS inquestId is already a parent of childId
NOT_FOUND inquestId or childId not found
NULL_ARGUMENT inquestId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildInquest
Description

Removes a child from an inquest.

Parametersosid.id.IdinquestIdthe Id of an inquest
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND inquestId is not parent of childId
NULL_ARGUMENT inquestId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildInquests
Description

Removes all children from an inquest.

Parametersosid.id.IdinquestIdthe Id of an inquest
ErrorsNOT_FOUND inquestId is not found
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.