OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.RepositoryHierarchySession
Implementsosid.OsidSession
Description

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
MethodgetRepositoryHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRepositoryHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessRepositoryHierarchy
Description

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.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeRepositoryView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryRepositoryView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodgetRootRepositoryIds
Description

Gets the root repository Ids in this hierarchy.

Returnosid.id.IdListthe root repository Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootRepositories
Description

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.

Returnosid.repository.RepositoryListthe root repositories
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentRepositories
Description

Tests if the Repository has any parents.

Parametersosid.id.IdrepositoryIda repository Id
Returnboolean true if the repository has parents, false otherwise
ErrorsNOT_FOUND repositoryId is not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfRepository
Description

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

Parametersosid.id.Ididan Id
osid.id.IdrepositoryIdthe Id of a repository
Returnboolean true if this id is a parent of repositoryId, false otherwise
ErrorsNOT_FOUND repositoryId is not found
NULL_ARGUMENT id or repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentRepositoryIds
Description

Gets the parent Ids of the given repository.

Parametersosid.id.IdrepositoryIda repository Id
Returnosid.id.IdListthe parent Ids of the repository
ErrorsNOT_FOUND repositoryId is not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentRepositories
Description

Gets the parents of the given repository.

Parametersosid.id.IdrepositoryIdthe Id to query
Returnosid.repository.RepositoryListthe parents of the repository
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfRepository
Description

Tests if an Id is an ancestor of a repository.

Parametersosid.id.Ididan Id
osid.id.IdrepositoryIdthe Id of a repository
Returnboolean true if this id is an ancestor of repositoryId, false otherwise
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildRepositories
Description

Tests if a repository has any children.

Parametersosid.id.IdrepositoryIda repository Id
Returnboolean true if the repositoryId has children, false otherwise
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfRepository
Description

Tests if a node is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdrepositoryIdthe Id of a repository
Returnboolean true if the id is a child of repositoryId, false otherwise
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildRepositoryIds
Description

Gets the Ids of the children of the given repository.

Parametersosid.id.IdrepositoryIdthe Id to query
Returnosid.id.IdListthe children of the repository
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildRepositories
Description

Gets the children of the given repository.

Parametersosid.id.IdrepositoryIdthe Id to query
Returnosid.repository.RepositoryListthe children of the repository
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfRepository
Description

Tests if an Id is a descendant of a repository.

Parametersosid.id.Ididan Id
osid.id.IdrepositoryIdthe Id of a repository
Returnboolean true if the id is a descendant of the repositoryId, false otherwise
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetRepositoryNodeIds
Description

Gets a portion of the hierarchy for the given repository.

Parametersosid.id.IdrepositoryIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodethe specified repository node
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRepositoryNodes
Description

Gets a portion of the hierarchy for the given repository.

Parametersosid.id.IdrepositoryIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.repository.RepositoryNodethe specified repository node
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.