OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.BankHierarchySession
Implementsosid.OsidSession
Description

This session defines methods for traversing a hierarchy of Bank objects. Each node in the hierarchy is a unique Bank. The hierarchy may be traversed recursively to establish the tree structure through getParentBanks() and getChildBanks(). To relate these Ids to another OSID, getBankNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Bank available in the Assessment 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 getParentBanks() or getChildBanks() 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: bank elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
MethodgetBankHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDassessment failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessBankHierarchy
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.
MethoduseComparativeBankView
Description

The returns from the bank methods may omit or translate elements based on this session, such as assessment, 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.
MethodusePlenaryBankView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodgetRootBankIds
Description

Gets the root bank Ids in this hierarchy.

Returnosid.id.IdListthe root bank Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetRootBanks
Description

Gets the root banks in this bank hierarchy.

Returnosid.assessment.BankListthe root banks
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method is must be implemented.
MethodhasParentBanks
Description

Tests if the Bank has any parents.

Parametersosid.id.IdbankIda bank Id
Returnboolean true if the bank has parents, false otherwise
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodisParentOfBank
Description

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

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

If id not found return false.

MethodgetParentBankIds
Description

Gets the parent Ids of the given bank.

Parametersosid.id.IdbankIda bank Id
Returnosid.id.IdListthe parent Ids of the bank
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetParentBanks
Description

Gets the parents of the given bank.

Parametersosid.id.IdbankIda bank Id
Returnosid.assessment.BankListthe parents of the bank
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfBank
Description

Tests if an Id is an ancestor of a bank.

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

If id not found return false.

MethodhasChildBanks
Description

Tests if a bank has any children.

Parametersosid.id.IdbankIda bankId
Returnboolean true if the bankId has children, false otherwise
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfBank
Description

Tests if a bank is a direct child of another.

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

If id not found return false.

MethodgetChildBankIds
Description

Gets the child Ids of the given bank.

Parametersosid.id.IdbankIdthe Id to query
Returnosid.id.IdListthe children of the bank
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildBanks
Description

Gets the children of the given bank.

Parametersosid.id.IdbankIdthe Id to query
Returnosid.assessment.BankListthe children of the bank
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfBank
Description

Tests if an Id is a descendant of a bank.

Parametersosid.id.Ididan Id
osid.id.IdbankIdthe Id of a bank
Returnboolean true if the id is a descendant of the bankId, false otherwise
ErrorsNOT_FOUND bankId not found
NULL_ARGUMENT bankId 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.

MethodgetBankNodeIds
Description

Gets a portion of the hierarchy for the given bank.

Parametersosid.id.IdbankIdthe 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.Nodea bank node
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBankNodes
Description

Gets a portion of the hierarchy for the given bank.

Parametersosid.id.IdbankIdthe 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.assessment.BankNodea bank node
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.