Interface ChecklistHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ChecklistHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Checklists . Each node in the hierarchy is a unique Checklist . The hierarchy may be traversed recursively to establish the tree structure through getParentChecklists() and getChildChecklists() . To relate these Ids to another OSID, getChecklistNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Checklist available in the Todoing OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentChecklists() or getChildChecklists() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: checklist elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessChecklistHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getChecklistHierarchy()	Gets the hierarchy associated with this session.
Id	getChecklistHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getChecklistNodeIds(Id checklistId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given checklist.
ChecklistNode	getChecklistNodes(Id checklistId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given checklist.
IdList	getChildChecklistIds(Id checklistId)	Gets the child Ids of the given checklist.
ChecklistList	getChildChecklists(Id checklistId)	Gets the child checklists of the given id .
IdList	getParentChecklistIds(Id checklistId)	Gets the parent Ids of the given checklist.
ChecklistList	getParentChecklists(Id checklistId)	Gets the parent checklists of the given id .
IdList	getRootChecklistIds()	Gets the root checklist Ids in this hierarchy.
ChecklistList	getRootChecklists()	Gets the root checklists in the checklist hierarchy.
boolean	hasChildChecklists(Id checklistId)	Tests if a checklist has any children.
boolean	hasParentChecklists(Id checklistId)	Tests if the Checklist has any parents.
boolean	isAncestorOfChecklist(Id id, Id checklistId)	Tests if an Id is an ancestor of a checklist.
boolean	isChildOfChecklist(Id id, Id checklistId)	Tests if a checklist is a direct child of another.
boolean	isDescendantOfChecklist(Id id, Id checklistId)	Tests if an Id is a descendant of a checklist.
boolean	isParentOfChecklist(Id id, Id checklistId)	Tests if an Id is a direct parent of checklist.
void	useComparativeChecklistView()	The returns from the checklist methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryChecklistView()	A complete view of the Checklist returns is desired.

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.

canAccessChecklistHierarchy

boolean canAccessChecklistHierarchy()

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeChecklistView

void useComparativeChecklistView()

The returns from the checklist methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryChecklistView

void usePlenaryChecklistView()

A complete view of the Checklist returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRootChecklistIds

IdList getRootChecklistIds()
                    throws OperationFailedException,
PermissionDeniedException

Gets the root checklist Ids in this hierarchy.

Returns:

the root checklist Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootChecklists

ChecklistList getRootChecklists()
                         throws OperationFailedException,
PermissionDeniedException

Gets the root checklists in the checklist hierarchy. A node with no parents is an orphan. While all checklist Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returns:

the root checklists

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentChecklists

boolean hasParentChecklists(Id checklistId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Checklist has any parents.

Parameters:

checklistId - a checklist Id

Returns:

true if the checklist has parents, f alse otherwise

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfChecklist

boolean isParentOfChecklist(Id id,
 Id checklistId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of checklist.

Parameters:

id - an Id

checklistId - the Id of a checklist

Returns:

true if this id is a parent of checklistId , f alse otherwise

Throws:

NotFoundException - checklistId is not found

NullArgumentException - id or checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentChecklistIds

IdList getParentChecklistIds(Id checklistId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given checklist.

Parameters:

checklistId - a checklist Id

Returns:

the parent Ids of the checklist

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentChecklists

ChecklistList getParentChecklists(Id checklistId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent checklists of the given id .

Parameters:

checklistId - the Id of the Checklist to query

Returns:

the parent checklists of the id

Throws:

NotFoundException - a Checklist identified by Id is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfChecklist

boolean isAncestorOfChecklist(Id id,
 Id checklistId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a checklist.

Parameters:

id - an Id

checklistId - the Id of a checklist

Returns:

true if this id is an ancestor of checklistId , false otherwise

Throws:

NotFoundException - checklistId is not found

NullArgumentException - id or checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildChecklists

boolean hasChildChecklists(Id checklistId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a checklist has any children.

Parameters:

checklistId - a checklist Id

Returns:

true if the checklistId has children, false otherwise

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfChecklist

boolean isChildOfChecklist(Id id,
 Id checklistId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a checklist is a direct child of another.

Parameters:

id - an Id

checklistId - the Id of a checklist

Returns:

true if the id is a child of checklistId , false otherwise

Throws:

NotFoundException - checklistId is not found

NullArgumentException - id or checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildChecklistIds

IdList getChildChecklistIds(Id checklistId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given checklist.

Parameters:

checklistId - the Id to query

Returns:

the children of the checklist

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildChecklists

ChecklistList getChildChecklists(Id checklistId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child checklists of the given id .

Parameters:

checklistId - the Id of the Checklist to query

Returns:

the child checklists of the id

Throws:

NotFoundException - a Checklist identified by Id is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfChecklist

boolean isDescendantOfChecklist(Id id,
 Id checklistId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a checklist.

Parameters:

id - an Id

checklistId - the Id of a checklist

Returns:

true if the id is a descendant of the checklistId , false otherwise

Throws:

NotFoundException - checklistId is not found

NullArgumentException - id or checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getChecklistNodeIds

Node getChecklistNodeIds(Id checklistId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given checklist.

Parameters:

checklistId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a checklist node

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChecklistNodes

ChecklistNode getChecklistNodes(Id checklistId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given checklist.

Parameters:

checklistId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a checklist node

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.