Interface ChecklistHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getChecklistHierarchyId

Id getChecklistHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getChecklistHierarchy

Hierarchy getChecklistHierarchy()
                         throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyChecklistHierarchy

boolean canModifyChecklistHierarchy()

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.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootChecklist

void addRootChecklist(Id checklistId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root checklist.

Parameters:

checklistId - the Id of a checklist

Throws:

AlreadyExistsException - checklistId is already in hierarchy

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootChecklist

void removeRootChecklist(Id checklistId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root checklist.

Parameters:

checklistId - the Id of a checklist

Throws:

NotFoundException - checklistId is not a root

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildChecklist

void addChildChecklist(Id checklistId,
 Id childId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a checklist.

Parameters:

checklistId - the Id of a checklist

childId - the Id of the new child

Throws:

AlreadyExistsException - checklistId is already a parent of childId

NotFoundException - checklistId or childId not found

NullArgumentException - checklistId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildChecklist

void removeChildChecklist(Id checklistId,
 Id childId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a checklist.

Parameters:

checklistId - the Id of a checklist

childId - the Id of the new child

Throws:

NotFoundException - checklistId not a parent of childId

NullArgumentException - checklistId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildChecklists

void removeChildChecklists(Id checklistId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a checklist.

Parameters:

checklistId - the Id of a checklist

Throws:

NotFoundException - checklistId not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.