Interface InquestHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InquestHierarchySession
extends OsidSession

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

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 getParentInquests() or getChildInquests() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized inquiryways.

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

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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessInquestHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildInquestIds(Id inquestId)	Gets the child Ids of the given inquest.
InquestList	getChildInquests(Id inquestId)	Gets the children of the given inquest.
Hierarchy	getInquestHierarchy()	Gets the hierarchy associated with this session.
Id	getInquestHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getInquestNodeIds(Id inquestId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given inquest.
InquestNode	getInquestNodes(Id inquestId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given inquest.
IdList	getParentInquestIds(Id inquestId)	Gets the parent Ids of the given inquest.
InquestList	getParentInquests(Id inquestId)	Gets the parents of the given inquest.
IdList	getRootInquestIds()	Gets the root inquest Ids in this hierarchy.
InquestList	getRootInquests()	Gets the root inquest in the inquest hierarchy.
boolean	hasChildInquests(Id inquestId)	Tests if an inquest has any children.
boolean	hasParentInquests(Id inquestId)	Tests if the Inquest has any parents.
boolean	isAncestorOfInquest(Id id, Id inquestId)	Tests if an Id is an ancestor of an inquest.
boolean	isChildOfInquest(Id id, Id inquestId)	Tests if an inquest is a direct child of another.
boolean	isDescendantOfInquest(Id id, Id inquestId)	Tests if an Id is a descendant of an inquest.
boolean	isParentOfInquest(Id id, Id inquestId)	Tests if an Id is a direct parent of inquest.
void	useComparativeInquestView()	The returns from the inquest methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryInquestView()	A complete view of the Inquests 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

getInquestHierarchyId

Id getInquestHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getInquestHierarchy

Hierarchy getInquestHierarchy()
                       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.

canAccessInquestHierarchy

boolean canAccessInquestHierarchy()

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.

useComparativeInquestView

void useComparativeInquestView()

The returns from the inquest 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.

usePlenaryInquestView

void usePlenaryInquestView()

A complete view of the Inquests 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.

getRootInquestIds

IdList getRootInquestIds()
                  throws OperationFailedException,
PermissionDeniedException

Gets the root inquest Ids in this hierarchy.

Returns:

the root inquest Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootInquests

InquestList getRootInquests()
                     throws OperationFailedException,
PermissionDeniedException

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

Returns:

the root inquests

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentInquests

boolean hasParentInquests(Id inquestId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Inquest has any parents.

Parameters:

inquestId - an inquest Id

Returns:

true if the inquest has parents, f alse otherwise

Throws:

NotFoundException - inquestId is not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfInquest

boolean isParentOfInquest(Id id,
 Id inquestId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of inquest.

Parameters:

id - an Id

inquestId - the Id of an inquest

Returns:

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

Throws:

NotFoundException - inquestId is not found

NullArgumentException - id or inquestId 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} .

getParentInquestIds

IdList getParentInquestIds(Id inquestId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given inquest.

Parameters:

inquestId - an inquest Id

Returns:

the parent Ids of the inquest

Throws:

NotFoundException - inquestId is not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentInquests

InquestList getParentInquests(Id inquestId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given inquest.

Parameters:

inquestId - the Id to query

Returns:

the parents of the inquest

Throws:

NotFoundException - inquestId not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfInquest

boolean isAncestorOfInquest(Id id,
 Id inquestId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an inquest.

Parameters:

id - an Id

inquestId - the Id of an inquest

Returns:

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

Throws:

NotFoundException - inquestId not found

NullArgumentException - inquestId or id 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} .

hasChildInquests

boolean hasChildInquests(Id inquestId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an inquest has any children.

Parameters:

inquestId - an inquest Id

Returns:

true if the inquestId has children, false otherwise

Throws:

NotFoundException - inquestId not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfInquest

boolean isChildOfInquest(Id id,
 Id inquestId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an inquest is a direct child of another.

Parameters:

id - an Id

inquestId - the Id of an inquest

Returns:

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

Throws:

NotFoundException - inquestId not found

NullArgumentException - id or inquestId 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} .

getChildInquestIds

IdList getChildInquestIds(Id inquestId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given inquest.

Parameters:

inquestId - the Id to query

Returns:

the children of the inquest

Throws:

NotFoundException - inquestId not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildInquests

InquestList getChildInquests(Id inquestId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given inquest.

Parameters:

inquestId - the Id to query

Returns:

the children of the inquest

Throws:

NotFoundException - inquestId not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfInquest

boolean isDescendantOfInquest(Id id,
 Id inquestId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an inquest.

Parameters:

id - an Id

inquestId - the Id of an inquest

Returns:

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

Throws:

NotFoundException - inquestId not found

NullArgumentException - id or inquestId 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} .

getInquestNodeIds

Node getInquestNodeIds(Id inquestId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given inquest.

Parameters:

inquestId - the Id to query

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

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

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

Returns:

an inquest node

Throws:

NotFoundException - inquestId not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestNodes

InquestNode getInquestNodes(Id inquestId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given inquest.

Parameters:

inquestId - the Id to query

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

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

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

Returns:

an inquest node

Throws:

NotFoundException - inquestId not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.