Interface QualifierHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface QualifierHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Qualifier objects. Each node in the hierarchy is a unique Qualifier . The hierarchy may be traversed recursively to establish the tree structure through getParentQualifiers() and getChildQualifiers() . To relate these Ids to another OSID, getQualifierNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Qualifier available in the Authorization 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 getParentQualifiers() or getChildQualifiers() 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: qualifier 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	canAccessQualifierHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildQualifierIds(Id qualifierId)	Gets the child Ids of the given qualifier.
QualifierList	getChildQualifiers(Id qualifierId)	Gets the children of the given qualifier.
IdList	getParentQualifierIds(Id qualifierId)	Gets the parent Ids of the given qualifier.
QualifierList	getParentQualifiers(Id qualifierId)	Gets the parents of the given qualifier.
Hierarchy	getQualifierHierarchy()	Gets the hierarchy associated with this session.
Id	getQualifierHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getQualifierNodeIds(Id qualifierId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given qualifier.
QualifierNode	getQualifierNodes(Id qualifierId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given qualifier.
IdList	getRootQualifierIds()	Gets the root qualifier Ids in this hierarchy.
QualifierList	getRootQualifiers()	Gets the root qualifiers in this qualifier hierarchy.
boolean	hasChildQualifiers(Id qualifierId)	Tests if a qualifier has any children.
boolean	hasParentQualifiers(Id qualifierId)	Tests if the Qualifier has any parents.
boolean	isAncestorOfQualifier(Id id, Id qualifierId)	Tests if an Id is an ancestor of a qualifier.
boolean	isChildOfQualifier(Id id, Id qualifierId)	Tests if a node is a direct child of another.
boolean	isDescendantOfQualifier(Id id, Id qualifierId)	Tests if an Id is a descendant of a qualifier.
boolean	isParentOfQualifier(Id id, Id qualifierId)	Tests if an Id is a direct parent of qualifier.
void	useComparativeQualifierView()	The returns from the qualifier methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryQualifierView()	A complete view of the Hierarchy 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

getQualifierHierarchyId

Id getQualifierHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getQualifierHierarchy

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

canAccessQualifierHierarchy

boolean canAccessQualifierHierarchy()

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.

useComparativeQualifierView

void useComparativeQualifierView()

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

usePlenaryQualifierView

void usePlenaryQualifierView()

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

getRootQualifierIds

IdList getRootQualifierIds()
                    throws OperationFailedException,
PermissionDeniedException

Gets the root qualifier Ids in this hierarchy.

Returns:

the root qualifier Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootQualifiers

QualifierList getRootQualifiers()
                         throws OperationFailedException,
PermissionDeniedException

Gets the root qualifiers in this qualifier hierarchy.

Returns:

the root qualifiers

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentQualifiers

boolean hasParentQualifiers(Id qualifierId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Qualifier has any parents.

Parameters:

qualifierId - a qualifier Id

Returns:

true if the qualifier has parents, false otherwise

Throws:

NotFoundException - qualifierId is not found

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfQualifier

boolean isParentOfQualifier(Id id,
 Id qualifierId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of qualifier.

Parameters:

id - an Id

qualifierId - the Id of a qualifier

Returns:

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

Throws:

NotFoundException - qualifierId is not found

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

getParentQualifierIds

IdList getParentQualifierIds(Id qualifierId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given qualifier.

Parameters:

qualifierId - a qualifier Id

Returns:

the parent Ids of the qualifier

Throws:

NotFoundException - qualifierId is not found

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentQualifiers

QualifierList getParentQualifiers(Id qualifierId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given qualifier.

Parameters:

qualifierId - a qualifier Id

Returns:

the parents of the qualifier

Throws:

NotFoundException - qualifierId is not found

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfQualifier

boolean isAncestorOfQualifier(Id id,
 Id qualifierId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a qualifier.

Parameters:

id - an Id

qualifierId - the Id of a qualifier

Returns:

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

Throws:

NotFoundException - qualifierId not found

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

hasChildQualifiers

boolean hasChildQualifiers(Id qualifierId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a qualifier has any children.

Parameters:

qualifierId - a qualifier Id

Returns:

true if the qualifierId has children, false otherwise

Throws:

NotFoundException - qualifierId not found

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfQualifier

boolean isChildOfQualifier(Id id,
 Id qualifierId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a node is a direct child of another.

Parameters:

id - an Id

qualifierId - the Id of a qualifier

Returns:

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

Throws:

NotFoundException - qualifierId not found

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

getChildQualifierIds

IdList getChildQualifierIds(Id qualifierId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given qualifier.

Parameters:

qualifierId - the Id to query

Returns:

the children of the qualifier

Throws:

NotFoundException - qualifierId is not found

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildQualifiers

QualifierList getChildQualifiers(Id qualifierId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given qualifier.

Parameters:

qualifierId - the Id to query

Returns:

the children of the qualifier

Throws:

NotFoundException - qualifierId is not found

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfQualifier

boolean isDescendantOfQualifier(Id id,
 Id qualifierId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a qualifier.

Parameters:

id - an Id

qualifierId - the Id of a qualifier

Returns:

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

Throws:

NotFoundException - qualifierId not found

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

getQualifierNodeIds

Node getQualifierNodeIds(Id qualifierId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given qualifier.

Parameters:

qualifierId - 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 qualifier node

Throws:

NotFoundException - functionId is not found

NullArgumentException - functionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQualifierNodes

QualifierNode getQualifierNodes(Id qualifierId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given qualifier.

Parameters:

qualifierId - 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 qualifier node

Throws:

NotFoundException - functionId is not found

NullArgumentException - functionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.