Interface RepositoryHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RepositoryHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Repository objects. Each node in the hierarchy is a unique Repository . The hierarchy may be traversed recursively to establish the tree structure through getParents() and getChildren() . To relate these Ids to another OSID, getAncestors() and getDescendants() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Repository available in the Repository 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 getParents() or getChildren() 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: repository 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	canAccessRepositoryHierarchy()	Tests if this user can perform hierarchy queries.
RepositoryList	getChildRepositories(Id repositoryId)	Gets the children of the given repository.
IdList	getChildRepositoryIds(Id repositoryId)	Gets the Ids of the children of the given repository.
RepositoryList	getParentRepositories(Id repositoryId)	Gets the parents of the given repository.
IdList	getParentRepositoryIds(Id repositoryId)	Gets the parent Ids of the given repository.
Hierarchy	getRepositoryHierarchy()	Gets the hierarchy associated with this session.
Id	getRepositoryHierarchyId()	Gets the hierarchy Id associated with this session.
IdList	getRepositoryNodeIds(Id repositoryId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given repository.
RepositoryNode	getRepositoryNodes(Id repositoryId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given repository.
RepositoryList	getRootRepositories()	Gets the root repositories in the repository hierarchy.
IdList	getRootRepositoryIds()	Gets the root repository Ids in this hierarchy.
boolean	hasChildRepositories(Id repositoryId)	Tests if a repository has any children.
boolean	hasParentRepositories(Id repositoryId)	Tests if the Repository has any parents.
boolean	isAncestorOfRepository(Id id, Id repositoryId)	Tests if an Id is an ancestor of a repository.
boolean	isChildOfRepository(Id id, Id repositoryId)	Tests if a node is a direct child of another.
boolean	isDescendantOfRepository(Id id, Id repositoryId)	Tests if an Id is a descendant of a repository.
boolean	isParentOfRepository(Id id, Id repositoryId)	Tests if an Id is a direct parent of a repository.
void	useComparativeRepositoryView()	The returns from the repository methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryRepositoryView()	A complete view of the Repository 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

getRepositoryHierarchyId

Id getRepositoryHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRepositoryHierarchy

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

canAccessRepositoryHierarchy

boolean canAccessRepositoryHierarchy()

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.

useComparativeRepositoryView

void useComparativeRepositoryView()

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

usePlenaryRepositoryView

void usePlenaryRepositoryView()

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

getRootRepositoryIds

IdList getRootRepositoryIds()
                     throws OperationFailedException,
PermissionDeniedException

Gets the root repository Ids in this hierarchy.

Returns:

the root repository Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootRepositories

RepositoryList getRootRepositories()
                            throws OperationFailedException,
PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentRepositories

boolean hasParentRepositories(Id repositoryId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Repository has any parents.

Parameters:

repositoryId - a repository Id

Returns:

true if the repository has parents, false otherwise

Throws:

NotFoundException - repositoryId is not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfRepository

boolean isParentOfRepository(Id id,
 Id repositoryId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

repositoryId - the Id of a repository

Returns:

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

Throws:

NotFoundException - repositoryId is not found

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

getParentRepositoryIds

IdList getParentRepositoryIds(Id repositoryId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given repository.

Parameters:

repositoryId - a repository Id

Returns:

the parent Ids of the repository

Throws:

NotFoundException - repositoryId is not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentRepositories

RepositoryList getParentRepositories(Id repositoryId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given repository.

Parameters:

repositoryId - the Id to query

Returns:

the parents of the repository

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfRepository

boolean isAncestorOfRepository(Id id,
 Id repositoryId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a repository.

Parameters:

id - an Id

repositoryId - the Id of a repository

Returns:

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

Throws:

NotFoundException - repositoryId not found

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

hasChildRepositories

boolean hasChildRepositories(Id repositoryId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a repository has any children.

Parameters:

repositoryId - a repository Id

Returns:

true if the repositoryId has children, false otherwise

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfRepository

boolean isChildOfRepository(Id id,
 Id repositoryId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a node is a direct child of another.

Parameters:

id - an Id

repositoryId - the Id of a repository

Returns:

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

Throws:

NotFoundException - repositoryId not found

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

getChildRepositoryIds

IdList getChildRepositoryIds(Id repositoryId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Ids of the children of the given repository.

Parameters:

repositoryId - the Id to query

Returns:

the children of the repository

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildRepositories

RepositoryList getChildRepositories(Id repositoryId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given repository.

Parameters:

repositoryId - the Id to query

Returns:

the children of the repository

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfRepository

boolean isDescendantOfRepository(Id id,
 Id repositoryId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a repository.

Parameters:

id - an Id

repositoryId - the Id of a repository

Returns:

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

Throws:

NotFoundException - repositoryId not found

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

getRepositoryNodeIds

IdList getRepositoryNodeIds(Id repositoryId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given repository.

Parameters:

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

the specified repository node

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRepositoryNodes

RepositoryNode getRepositoryNodes(Id repositoryId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given repository.

Parameters:

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

the specified repository node

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.