Interface ObjectiveBankHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ObjectiveBankHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of ObjectiveBanks . Each node in the hierarchy is a unique ObjectiveBank . The hierarchy may be traversed recursively to establish the tree structure through getParentObjectiveBanks() and getChildObjectiveBanks() . To relate these Ids to another OSID, getObjectiveBankNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any ObjectiveBank available in the ObjectiveBanking 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 getParentObjectiveBanks() or getChildObjectiveBanks() 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 bank 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	canAccessObjectiveBankHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildObjectiveBankIds(Id objectiveBankId)	Gets the child Ids of the given objective bank.
ObjectiveBankList	getChildObjectiveBanks(Id objectiveBankId)	Gets the children of the given objective bank.
Hierarchy	getObjectiveBankHierarchy()	Gets the hierarchy associated with this session.
Id	getObjectiveBankHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getObjectiveBankNodeIds(Id objectiveBankId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given objective bank.
ObjectiveBankNode	getObjectiveBankNodes(Id objectiveBankId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given objective bank.
IdList	getParentObjectiveBankIds(Id objectiveBankId)	Gets the parent Ids of the given objective bank.
ObjectiveBankList	getParentObjectiveBanks(Id objectiveBankId)	Gets the parents of the given objective bank.
IdList	getRootObjectiveBankIds()	Gets the root objective bank Ids in this hierarchy.
ObjectiveBankList	getRootObjectiveBanks()	Gets the root objective banks in this objective bank hierarchy.
boolean	hasChildObjectiveBanks(Id objectiveBankId)	Tests if an objective bank has any children.
boolean	hasParentObjectiveBanks(Id objectiveBankId)	Tests if the ObjectiveBank has any parents.
boolean	isAncestorOfObjectiveBank(Id id, Id objectiveBankId)	Tests if an Id is an ancestor of an objective bank.
boolean	isChildOfObjectiveBank(Id id, Id objectiveBankId)	Tests if an objective bank is a direct child of another.
boolean	isDescendantOfObjectiveBank(Id id, Id objectiveBankId)	Tests if an Id is a descendant of an objective bank.
boolean	isParentOfObjectiveBank(Id id, Id objectiveBankId)	Tests if an Id is a direct parent of an objective bank.
void	useComparativeObjectiveBankView()	The returns from the objective bank methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryObjectiveBankView()	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

getObjectiveBankHierarchyId

Id getObjectiveBankHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getObjectiveBankHierarchy

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

canAccessObjectiveBankHierarchy

boolean canAccessObjectiveBankHierarchy()

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.

useComparativeObjectiveBankView

void useComparativeObjectiveBankView()

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

usePlenaryObjectiveBankView

void usePlenaryObjectiveBankView()

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.

getRootObjectiveBankIds

IdList getRootObjectiveBankIds()
                        throws OperationFailedException,
PermissionDeniedException

Gets the root objective bank Ids in this hierarchy.

Returns:

the root objective bank Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootObjectiveBanks

ObjectiveBankList getRootObjectiveBanks()
                                 throws OperationFailedException,
PermissionDeniedException

Gets the root objective banks in this objective bank hierarchy.

Returns:

the root objective banks

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentObjectiveBanks

boolean hasParentObjectiveBanks(Id objectiveBankId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the ObjectiveBank has any parents.

Parameters:

objectiveBankId - the Id of an objective bank

Returns:

true if the objective bank has parents, false otherwise

Throws:

NotFoundException - objectiveBankId is not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfObjectiveBank

boolean isParentOfObjectiveBank(Id id,
 Id objectiveBankId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

objectiveBankId - the Id of an objective bank

Returns:

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

Throws:

NotFoundException - objectiveBankId is not found

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

getParentObjectiveBankIds

IdList getParentObjectiveBankIds(Id objectiveBankId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given objective bank.

Parameters:

objectiveBankId - the Id of an objective bank

Returns:

the parent Ids of the objective bank

Throws:

NotFoundException - objectiveBankId is not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentObjectiveBanks

ObjectiveBankList getParentObjectiveBanks(Id objectiveBankId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given objective bank.

Parameters:

objectiveBankId - the Id of an objective bank

Returns:

the parents of the objective bank

Throws:

NotFoundException - objectiveBankId is not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfObjectiveBank

boolean isAncestorOfObjectiveBank(Id id,
 Id objectiveBankId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an objective bank.

Parameters:

id - an Id

objectiveBankId - the Id of an objective bank

Returns:

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

Throws:

NotFoundException - objectiveBankId is not found

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

hasChildObjectiveBanks

boolean hasChildObjectiveBanks(Id objectiveBankId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an objective bank has any children.

Parameters:

objectiveBankId - the Id of an objective bank

Returns:

true if the objectiveBankId has children, false otherwise

Throws:

NotFoundException - objectiveBankId is not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfObjectiveBank

boolean isChildOfObjectiveBank(Id id,
 Id objectiveBankId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an objective bank is a direct child of another.

Parameters:

id - an Id

objectiveBankId - the Id of an objective bank

Returns:

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

Throws:

NotFoundException - objectiveBankId is not found

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

getChildObjectiveBankIds

IdList getChildObjectiveBankIds(Id objectiveBankId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given objective bank.

Parameters:

objectiveBankId - the Id to query

Returns:

the children of the objective bank

Throws:

NotFoundException - objectiveBankId is not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildObjectiveBanks

ObjectiveBankList getChildObjectiveBanks(Id objectiveBankId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given objective bank.

Parameters:

objectiveBankId - the Id to query

Returns:

the children of the objective bank

Throws:

NotFoundException - objectiveBankId is not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfObjectiveBank

boolean isDescendantOfObjectiveBank(Id id,
 Id objectiveBankId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an objective bank.

Parameters:

id - an Id

objectiveBankId - the Id of an objective bank

Returns:

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

Throws:

NotFoundException - objectiveBankId is not found

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

getObjectiveBankNodeIds

Node getObjectiveBankNodeIds(Id objectiveBankId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given objective bank.

Parameters:

objectiveBankId - 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 - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getObjectiveBankNodes

ObjectiveBankNode getObjectiveBankNodes(Id objectiveBankId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given objective bank.

Parameters:

objectiveBankId - 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 bank node

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.