Interface TermHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TermHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Terms . Each term in the hierarchy is a unique Term . The hierarchy may be traversed recursively to establish the tree structure through getParentTerms() and getChildTerms() . To relate these Ids to another OSID, getTermNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Term available in the Course 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 getParentTerms() or getChildTerms() 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: term 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	canAccessTermHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildTermIds(Id termId)	Gets the child Ids of the given term.
TermList	getChildTerms(Id termId)	Gets the children of the given term.
IdList	getParentTermIds(Id termId)	Gets the parent Ids of the given term.
TermList	getParentTerms(Id termId)	Gets the parents of the given term.
IdList	getRootTermIds()	Gets the root term Ids in this hierarchy.
TermList	getRootTerms()	Gets the root terms in the term hierarchy.
Hierarchy	getTermHierarchy()	Gets the hierarchy associated with this session.
Id	getTermHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getTermNodeIds(Id termId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given term.
TermNode	getTermNodes(Id termId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given term.
boolean	hasChildTerms(Id termId)	Tests if a term has any children.
boolean	hasParentTerms(Id termId)	Tests if the Term has any parents.
boolean	isAncestorOfTerm(Id id, Id termId)	Tests if an Id is an ancestor of a term.
boolean	isChildOfTerm(Id id, Id termId)	Tests if a node is a direct child of another.
boolean	isDescendantOfTerm(Id id, Id termId)	Tests if an Id is a descendant of a term.
boolean	isParentOfTerm(Id id, Id termId)	Tests if an Id is a direct parent of term.
void	useComparativeTermView()	The returns from the term methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryTermView()	A complete view of the Terms 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

getTermHierarchyId

Id getTermHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getTermHierarchy

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

canAccessTermHierarchy

boolean canAccessTermHierarchy()

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.

useComparativeTermView

void useComparativeTermView()

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

usePlenaryTermView

void usePlenaryTermView()

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

getRootTermIds

IdList getRootTermIds()
               throws OperationFailedException,
PermissionDeniedException

Gets the root term Ids in this hierarchy.

Returns:

the root term Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootTerms

TermList getRootTerms()
               throws OperationFailedException,
PermissionDeniedException

Gets the root terms in the term hierarchy. A node with no parents is an orphan. While all term 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 terms

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentTerms

boolean hasParentTerms(Id termId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Term has any parents.

Parameters:

termId - a term Id

Returns:

true if the term has parents, false otherwise

Throws:

NotFoundException - termId is not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfTerm

boolean isParentOfTerm(Id id,
 Id termId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of term.

Parameters:

id - an Id

termId - the Id of a term

Returns:

true if this id is a parent of termId , false otherwise

Throws:

NotFoundException - termId is not found

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

getParentTermIds

IdList getParentTermIds(Id termId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given term.

Parameters:

termId - a term Id

Returns:

the parent Ids of the term

Throws:

NotFoundException - termId is not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentTerms

TermList getParentTerms(Id termId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given term.

Parameters:

termId - the Id to query

Returns:

the parents of the term

Throws:

NotFoundException - termId not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfTerm

boolean isAncestorOfTerm(Id id,
 Id termId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a term.

Parameters:

id - an Id

termId - the Id of a term

Returns:

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

Throws:

NotFoundException - termId not found

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

hasChildTerms

boolean hasChildTerms(Id termId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a term has any children.

Parameters:

termId - a term Id

Returns:

true if the termId has children, false otherwise

Throws:

NotFoundException - termId not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfTerm

boolean isChildOfTerm(Id id,
 Id termId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a node is a direct child of another.

Parameters:

id - an Id

termId - the Id of a term

Returns:

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

Throws:

NotFoundException - termId not found

NullArgumentException - termId 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} .

getChildTermIds

IdList getChildTermIds(Id termId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given term.

Parameters:

termId - a term Id

Returns:

the child Ids of the term

Throws:

NotFoundException - termId is not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildTerms

TermList getChildTerms(Id termId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given term.

Parameters:

termId - the Id to query

Returns:

the children of the term

Throws:

NotFoundException - termId not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfTerm

boolean isDescendantOfTerm(Id id,
 Id termId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a term.

Parameters:

id - an Id

termId - the Id of a term

Returns:

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

Throws:

NotFoundException - termId not found

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

getTermNodeIds

Node getTermNodeIds(Id termId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given term.

Parameters:

termId - 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 term node

Throws:

NotFoundException - termId not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTermNodes

TermNode getTermNodes(Id termId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given term.

Parameters:

termId - 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 term node

Throws:

NotFoundException - termId not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.