public interface ChecklistHierarchyDesignSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
addChildChecklist(Id checklistId,
Id childId)
Adds a child to a checklist.
|
void |
addRootChecklist(Id checklistId)
Adds a root checklist.
|
boolean |
canModifyChecklistHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getChecklistHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getChecklistHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildChecklist(Id checklistId,
Id childId)
Removes a child from a checklist.
|
void |
removeChildChecklists(Id checklistId)
Removes all children from a checklist.
|
void |
removeRootChecklist(Id checklistId)
Removes a root checklist.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getChecklistHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getChecklistHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyChecklistHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootChecklist(Id checklistId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
checklistId
- the Id
of a checklistAlreadyExistsException
- checklistId
is
already in hierarchyNotFoundException
- checklistId
is not
foundNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootChecklist(Id checklistId) throws NotFoundException, OperationFailedException, PermissionDeniedException
checklistId
- the Id
of a checklistNotFoundException
- checklistId
is not a
rootNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildChecklist(Id checklistId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
checklistId
- the Id
of a checklistchildId
- the Id
of the new childAlreadyExistsException
- checklistId
is
already a parent of childId
NotFoundException
- checklistId
or
childId
not foundNullArgumentException
- checklistId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildChecklist(Id checklistId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
checklistId
- the Id
of a checklistchildId
- the Id
of the new childNotFoundException
- checklistId
not a
parent of childId
NullArgumentException
- checklistId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildChecklists(Id checklistId) throws NotFoundException, OperationFailedException, PermissionDeniedException
checklistId
- the Id
of a checklistNotFoundException
- checklistId
not
foundNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.