Interface | osid.assessment.BankHierarchySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for traversing a hierarchy of
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 This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | getBankHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBankHierarchy | ||
Description |
Gets the hierarchy associated with this session. | ||
Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | assessment failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAccessBankHierarchy | ||
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 | ||
Return | boolean | false if hierarchy traversal methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeBankView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryBankView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootBankIds | ||
Description |
Gets the root bank | ||
Return | osid.id.IdList | the root bank Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootBanks | ||
Description |
Gets the root banks in this bank hierarchy. | ||
Return | osid.assessment.BankList | the root banks | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentBanks | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | bankId | a bank Id |
Return | boolean | true if the bank has parents, false otherwise | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | isParentOfBank | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | bankId | the Id of a bank | |
Return | boolean | true if this id is a parent of bankId,
false otherwise | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | id or bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentBankIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | bankId | a bank Id |
Return | osid.id.IdList | the parent Ids of the bank | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParentBanks | ||
Description |
Gets the parents of the given bank. | ||
Parameters | osid.id.Id | bankId | a bank Id |
Return | osid.assessment.BankList | the parents of the bank | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | isAncestorOfBank | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | bankId | the Id of a bank | |
Return | boolean | true if this id is an ancestor of
bankId, false otherwise | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildBanks | ||
Description |
Tests if a bank has any children. | ||
Parameters | osid.id.Id | bankId | a bankId |
Return | boolean | true if the bankId has children, false
otherwise | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isChildOfBank | ||
Description |
Tests if a bank is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | bankId | the Id of a bank | |
Return | boolean | true if the id is a child of bankId,
false otherwise | |
Errors | NOT_FOUND | bankId not found | |
NULL_ARGUMENT | bankId or id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildBankIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | bankId | the Id to query |
Return | osid.id.IdList | the children of the bank | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChildBanks | ||
Description |
Gets the children of the given bank. | ||
Parameters | osid.id.Id | bankId | the Id to query |
Return | osid.assessment.BankList | the children of the bank | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isDescendantOfBank | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | bankId | the Id of a bank | |
Return | boolean | true if the id is a descendant of the
bankId, false otherwise | |
Errors | NOT_FOUND | bankId not found | |
NULL_ARGUMENT | bankId or id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getBankNodeIds | ||
Description |
Gets a portion of the hierarchy for the given bank. | ||
Parameters | osid.id.Id | bankId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.hierarchy.Node | a bank node | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBankNodes | ||
Description |
Gets a portion of the hierarchy for the given bank. | ||
Parameters | osid.id.Id | bankId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.assessment.BankNode | a bank node | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |