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

This session defines methods for managing a hierarchy of Bank objects. Each node in the hierarchy is a unique Bank.

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.
MethodcanModifyBankHierarchy
Description

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootBank
Description

Adds a root bank.

Parametersosid.id.IdbankIdthe Id of a bank
ErrorsALREADY_EXISTS bankId is already in hierarchy
NOT_FOUND bankId not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodremoveRootBank
Description

Removes a root bank from this hierarchy.

Parametersosid.id.IdbankIdthe Id of a bank
ErrorsNOT_FOUND bankId not a parent of childId
NULL_ARGUMENT bankId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildBank
Description

Adds a child to a bank.

Parametersosid.id.IdbankIdthe Id of a bank
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS bankId is already a parent of childId
NOT_FOUND bankId or childId not found
NULL_ARGUMENT bankId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodremoveChildBank
Description

Removes a child from a bank.

Parametersosid.id.IdbankIdthe Id of a bank
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND bankId not parent of childId
NULL_ARGUMENT bankId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodremoveChildBanks
Description

Removes all children from a bank.

Parametersosid.id.IdbankIdthe Id of a bank
ErrorsNOT_FOUND bankId is not in hierarchy
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.