OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.ChecklistHierarchyDesignSession
Implementsosid.OsidSession
Description

This session manages a hierarchy of checklists. Checklists may be organized into a hierarchy for organizing or federating. A parent Checklist includes all of the todos of its children such that a single root node contains all of the todos of the federation.

MethodgetChecklistHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

Adds a root checklist.

Parametersosid.id.IdchecklistIdthe Id of a checklist
ErrorsALREADY_EXISTS checklistId is already in hierarchy
NOT_FOUND checklistId is not found
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootChecklist
Description

Removes a root checklist.

Parametersosid.id.IdchecklistIdthe Id of a checklist
ErrorsNOT_FOUND checklistId is not a root
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildChecklist
Description

Adds a child to a checklist.

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

Removes a child from a checklist.

Parametersosid.id.IdchecklistIdthe Id of a checklist
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND checklistId not a parent of childId
NULL_ARGUMENT checklistId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildChecklists
Description

Removes all children from a checklist.

Parametersosid.id.IdchecklistIdthe Id of a checklist
ErrorsNOT_FOUND checklistId not found
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.