Interface ObjectiveHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ObjectiveHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Objectives . Each node in the hierarchy is a unique Objective that contains its child objectives . The hierarchy may be traversed recursively to establish the tree structure through getParentObjectives() and getChildObjectives() . To relate these Ids to another OSID, getObjectiveNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Objective available in the Learning 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 getParentObjectives() or getChildObjectives() 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: objective 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	canAccessObjectiveHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildObjectiveIds(Id objectiveId)	Gets the child Ids of the given objective.
ObjectiveList	getChildObjectives(Id objectiveId)	Gets the children of the given objective.
Hierarchy	getObjectiveHierarchy()	Gets the hierarchy associated with this session.
Id	getObjectiveHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getObjectiveNodeIds(Id objectiveId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given objective.
ObjectiveNode	getObjectiveNodes(Id objectiveId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given objective.
IdList	getParentObjectiveIds(Id objectiveId)	Gets the parent Ids of the given objective.
ObjectiveList	getParentObjectives(Id objectiveId)	Gets the parents of the given objective.
IdList	getRootObjectiveIds()	Gets the root objective Ids in this hierarchy.
ObjectiveList	getRootObjectives()	Gets the root objective in this objective hierarchy.
boolean	hasChildObjectives(Id objectiveId)	Tests if an objective has any children.
boolean	hasParentObjectives(Id objectiveId)	Tests if the Objective has any parents.
boolean	isAncestorOfObjective(Id id, Id objectiveId)	Tests if an Id is an ancestor of an objective.
boolean	isChildOfObjective(Id id, Id objectiveId)	Tests if an objective is a direct child of another.
boolean	isDescendantOfObjective(Id id, Id objectiveId)	Tests if an Id is a descendant of an objective.
boolean	isParentOfObjective(Id id, Id objectiveId)	Tests if an Id is a direct parent of an objective.
void	useComparativeObjectiveView()	The returns from the objective methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryObjectiveView()	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

getObjectiveHierarchyId

Id getObjectiveHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getObjectiveHierarchy

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

canAccessObjectiveHierarchy

boolean canAccessObjectiveHierarchy()

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 an application that may not offer traversal functions to unauthorized users.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeObjectiveView

void useComparativeObjectiveView()

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

usePlenaryObjectiveView

void usePlenaryObjectiveView()

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.

getRootObjectiveIds

IdList getRootObjectiveIds()
                    throws OperationFailedException,
PermissionDeniedException

Gets the root objective Ids in this hierarchy.

Returns:

the root objective Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootObjectives

ObjectiveList getRootObjectives()
                         throws OperationFailedException,
PermissionDeniedException

Gets the root objective in this objective hierarchy.

Returns:

the root objective

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentObjectives

boolean hasParentObjectives(Id objectiveId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Objective has any parents.

Parameters:

objectiveId - the Id of an objective

Returns:

true if the objective has parents, false otherwise

Throws:

NotFoundException - objectiveId is not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfObjective

boolean isParentOfObjective(Id id,
 Id objectiveId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of an objective.

Parameters:

id - an Id

objectiveId - the Id of an objective

Returns:

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

Throws:

NotFoundException - objectiveId is not found

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

getParentObjectiveIds

IdList getParentObjectiveIds(Id objectiveId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given objective.

Parameters:

objectiveId - the Id of an objective

Returns:

the parent Ids of the objective

Throws:

NotFoundException - objectiveId is not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentObjectives

ObjectiveList getParentObjectives(Id objectiveId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given objective.

Parameters:

objectiveId - the Id of an objective

Returns:

the parents of the objective

Throws:

NotFoundException - objectiveId is not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfObjective

boolean isAncestorOfObjective(Id id,
 Id objectiveId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an objective.

Parameters:

id - an Id

objectiveId - the Id of an objective

Returns:

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

Throws:

NotFoundException - objectiveId is not found

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

hasChildObjectives

boolean hasChildObjectives(Id objectiveId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an objective has any children.

Parameters:

objectiveId - the Id of an objective

Returns:

true if the objectiveId has children, false otherwise

Throws:

NotFoundException - objectiveId is not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfObjective

boolean isChildOfObjective(Id id,
 Id objectiveId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an objective is a direct child of another.

Parameters:

id - an Id

objectiveId - the Id of an objective

Returns:

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

Throws:

NotFoundException - objectiveId is not found

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

getChildObjectiveIds

IdList getChildObjectiveIds(Id objectiveId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given objective.

Parameters:

objectiveId - the Id to query

Returns:

the children of the objective

Throws:

NotFoundException - objectiveId is not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildObjectives

ObjectiveList getChildObjectives(Id objectiveId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given objective.

Parameters:

objectiveId - the Id to query

Returns:

the children of the objective

Throws:

NotFoundException - objectiveId is not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfObjective

boolean isDescendantOfObjective(Id id,
 Id objectiveId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an objective.

Parameters:

id - an Id

objectiveId - the Id of an objective

Returns:

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

Throws:

NotFoundException - objectiveId is not found

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

getObjectiveNodeIds

Node getObjectiveNodeIds(Id objectiveId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given objective.

Parameters:

objectiveId - 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 catalog node

Throws:

NotFoundException - objectiveId not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getObjectiveNodes

ObjectiveNode getObjectiveNodes(Id objectiveId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given objective.

Parameters:

objectiveId - 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:

an objective node

Throws:

NotFoundException - objectiveId not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.