Assessment Open Service Interface Definitions assessment version 3.0.0
The Assessment OSID provides the means to create, access, and take
assessments. An Assessment may represent a quiz, survey, or other
evaluation that includes assessment Items. The OSID defines methods
to describe the flow of control and the relationships among the objects.
Assessment Items are extensible objects to capture various types of
questions, such as a multiple choice or an asset submission.
The Assessment service can br broken down into several distinct services:
- Assessment Taking
- Assessment and Item authoring
- Accessing and managing banks of assessments and items
Each of these service areas are covered by different session and object interfaces. The object interfaces describe both the structure of the assessment and follow an assessment management workflow of first defining assessment items and then authoring assessments based on those items. They are:
Item: a question and answer pairResponse:a response to anItemquestionAssessment: a set ofItemsAssessmentSection:A grouped set ofItemsAssessmentOffering:AnAssessmentavailable for takingAssessmentTaken:AnAssessmentOfferingthat has been completed or in progress
Taking Assessments
The AssessmentSession is used to take an assessment. It captures
various ways an assessment can be taken which may include time
constraints, the ability to suspend and resume, and the availability of
an answer.
Taking an Assessment involves first navigating through
AssessmentSections. An AssessmentSection is an advanced
authoring construct used to both visually divide an Assessment and
impose additional constraints. Basic assessments are assumed to always
have one AssessmentSection even if not explicitly created.
Authoring
A basic authoring session is available in this package to map Items
to Assessments. More sophisticated authoring using
AssessmentParts and sequencing is available in the Assessment
Authoring OSID.
Bank Cataloging
Assessments, AssessmentsOffered, AssessmentsTaken, and
Items may be organized into federateable catalogs called Banks .
Sub Packages
The Assessment OSID includes an Assessment Authoring OSID for more advanced authoring and sequencing options.
Service Managers¶
Assessment Manager¶
-
class
dlkit.services.assessment.AssessmentManager¶ Bases:
dlkit.osid.managers.OsidManager,dlkit.osid.sessions.OsidSession,dlkit.services.assessment.AssessmentProfileGets an
AssessmentAuthoringManager.Returns: an AssessmentAuthoringManagerReturn type: osid.assessment.authoring.AssessmentAuthoringManagerRaise: OperationFailed– unable to complete requestRaise: Unimplemented–supports_assessment_authoring() is false
-
assessment_batch_manager¶ Gets an
AssessmentBatchManager.Returns: an AssessmentBatchManagerReturn type: osid.assessment.batch.AssessmentBatchManagerRaise: OperationFailed– unable to complete requestRaise: Unimplemented–supports_assessment_batch() is false
Assessment Profile Methods¶
AssessmentManager.supports_assessment()¶Tests for the availability of a assessment service which is the service for taking and examining assessments taken.
Returns: trueif assessment is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_item_lookup()¶Tests if an item lookup service is supported.
Returns: true if item lookup is supported, false otherwise Return type: boolean
AssessmentManager.supports_item_query()¶Tests if an item query service is supported.
Returns: trueif item query is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_item_admin()¶Tests if an item administrative service is supported.
Returns: trueif item admin is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_assessment_lookup()¶Tests if an assessment lookup service is supported. An assessment lookup service defines methods to access assessments.
Returns: true if assessment lookup is supported, false otherwise Return type: boolean
AssessmentManager.supports_assessment_query()¶Tests if an assessment query service is supported.
Returns: trueif assessment query is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_assessment_admin()¶Tests if an assessment administrative service is supported.
Returns: trueif assessment admin is supported,falseotherwiseReturn type: boolean
Tests if an assessment basic authoring session is available.
Returns: trueif assessment basic authoring is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_assessment_offered_lookup()¶Tests if an assessment offered lookup service is supported.
Returns: true if assessment offered lookup is supported, false otherwise Return type: boolean
AssessmentManager.supports_assessment_offered_query()¶Tests if an assessment offered query service is supported.
Returns: trueif assessment offered query is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_assessment_offered_admin()¶Tests if an assessment offered administrative service is supported.
Returns: trueif assessment offered admin is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_assessment_taken_lookup()¶Tests if an assessment taken lookup service is supported.
Returns: trueif assessment taken lookup is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_assessment_taken_query()¶Tests if an assessment taken query service is supported.
Returns: trueif assessment taken query is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_assessment_taken_admin()¶Tests if an assessment taken administrative service is supported which is used to instantiate an assessment offered.
Returns: trueif assessment taken admin is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_bank_lookup()¶Tests if a bank lookup service is supported. A bank lookup service defines methods to access assessment banks.
Returns: trueif bank lookup is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_bank_admin()¶Tests if a banlk administrative service is supported.
Returns: trueif bank admin is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_bank_hierarchy()¶Tests if a bank hierarchy traversal is supported.
Returns: trueif a bank hierarchy traversal is supported,falseotherwiseReturn type: boolean
AssessmentManager.supports_bank_hierarchy_design()¶Tests if bank hierarchy design is supported.
Returns: trueif a bank hierarchy design is supported,falseotherwiseReturn type: boolean
AssessmentManager.item_record_types¶Gets the supported
Itemrecord types.
Returns: a list containing the supported Itemrecord typesReturn type: osid.type.TypeList
AssessmentManager.item_search_record_types¶Gets the supported
Itemsearch record types.
Returns: a list containing the supported Itemsearch record typesReturn type: osid.type.TypeList
AssessmentManager.assessment_record_types¶Gets the supported
Assessmentrecord types.
Returns: a list containing the supported Assessmentrecord typesReturn type: osid.type.TypeList
AssessmentManager.assessment_search_record_types¶Gets the supported
Assessmentsearch record types.
Returns: a list containing the supported assessment search record types Return type: osid.type.TypeList
AssessmentManager.assessment_offered_record_types¶Gets the supported
AssessmentOfferedrecord types.
Returns: a list containing the supported AssessmentOfferedrecord typesReturn type: osid.type.TypeList
AssessmentManager.assessment_offered_search_record_types¶Gets the supported
AssessmentOfferedsearch record types.
Returns: a list containing the supported AssessmentOfferedsearch record typesReturn type: osid.type.TypeList
AssessmentManager.assessment_taken_record_types¶Gets the supported
AssessmentTakenrecord types.
Returns: a list containing the supported AssessmentTakenrecord typesReturn type: osid.type.TypeList
AssessmentManager.assessment_taken_search_record_types¶Gets the supported
AssessmentTakensearch record types.
Returns: a list containing the supported AssessmentTakensearch record typesReturn type: osid.type.TypeList
AssessmentManager.assessment_section_record_types¶Gets the supported
AssessmentSectionrecord types.
Returns: a list containing the supported AssessmentSectionrecord typesReturn type: osid.type.TypeList
AssessmentManager.bank_record_types¶Gets the supported
Bankrecord types.
Returns: a list containing the supported Bankrecord typesReturn type: osid.type.TypeList
AssessmentManager.bank_search_record_types¶Gets the supported bank search record types.
Returns: a list containing the supported Banksearch record typesReturn type: osid.type.TypeList
Bank Lookup Methods¶
AssessmentManager.can_lookup_banks()¶Tests if this user can perform
Banklookups. 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 aPermissionDenied. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Returns: falseif lookup methods are not authorized,trueotherwiseReturn type: boolean
AssessmentManager.use_comparative_bank_view()¶The returns from the lookup 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.
AssessmentManager.use_plenary_bank_view()¶A complete view of the
Bankreturns 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.
AssessmentManager.get_banks_by_ids(bank_ids)¶Gets a
BankListcorresponding to the givenIdList. In plenary mode, the returned list contains all of the banks specified in theIdlist, in the order of the list, including duplicates, or an error results if anIdin the supplied list is not found or inaccessible. Otherwise, inaccessibleBankobjects may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters: bank_ids ( osid.id.IdList) – the list ofIdsto retrieveReturns: the returned BanklistReturn type: osid.assessment.BankListRaise: NotFound– anId wasnot foundRaise: NullArgument–bank_idsisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.get_banks_by_genus_type(bank_genus_type)¶Gets a
BankListcorresponding to the given bank genusTypewhich does not include banks of types derived from the specifiedType. In plenary mode, the returned list contains all known banks or an error results. Otherwise, the returned list may contain only those banks that are accessible through this session.
Parameters: bank_genus_type ( osid.type.Type) – a bank genus typeReturns: the returned BanklistReturn type: osid.assessment.BankListRaise: NullArgument–bank_genus_typeisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.get_banks_by_parent_genus_type(bank_genus_type)¶Gets a
BankListcorresponding to the given bank genusTypeand include any additional banks with genus types derived from the specifiedType. In plenary mode, the returned list contains all known banks or an error results. Otherwise, the returned list may contain only those banks that are accessible through this session.
Parameters: bank_genus_type ( osid.type.Type) – a bank genus typeReturns: the returned BanklistReturn type: osid.assessment.BankListRaise: NullArgument–bank_genus_typeisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.get_banks_by_record_type(bank_record_type)¶Gets a
BankListcontaining the given bank recordType. In plenary mode, the returned list contains all known banks or an error results. Otherwise, the returned list may contain only those banks that are accessible through this session.
Parameters: bank_record_type ( osid.type.Type) – a bank record typeReturns: the returned BanklistReturn type: osid.assessment.BankListRaise: NullArgument–bank_record_typeisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.get_banks_by_provider(resource_id)¶Gets a
BankListfrom the given provider ````. In plenary mode, the returned list contains all known banks or an error results. Otherwise, the returned list may contain only those banks that are accessible through this session.
Parameters: resource_id ( osid.id.Id) – a resourceIdReturns: the returned BanklistReturn type: osid.assessment.BankListRaise: NullArgument–resource_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.banks¶Gets all
Banks. In plenary mode, the returned list contains all known banks or an error results. Otherwise, the returned list may contain only those banks that are accessible through this session.
Returns: a BankListReturn type: osid.assessment.BankListRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
Bank Admin Methods¶
AssessmentManager.can_create_banks()¶Tests if this user can create
Banks. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating aBankwill result in aPermissionDenied. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Returns: falseifBankcreation is not authorized,trueotherwiseReturn type: boolean
AssessmentManager.can_create_bank_with_record_types(bank_record_types)¶Tests if this user can create a single
Bankusing the desired record types. WhileAssessmentManager.getBankRecordTypes()can be used to examine which records are supported, this method tests which record(s) are required for creating a specificBank. Providing an empty array tests if aBankcan be created with no records.
Parameters: bank_record_types ( osid.type.Type[]) – array of bank record typesReturns: trueifBankcreation using the specifiedTypesis supported,falseotherwiseReturn type: booleanRaise: NullArgument–bank_record_typesisnull
AssessmentManager.get_bank_form_for_create(bank_record_types)¶Gets the bank form for creating new banks. A new form should be requested for each create transaction.
Parameters: bank_record_types ( osid.type.Type[]) – array of bank record types to be included in the create operation or an empty list if noneReturns: the bank form Return type: osid.assessment.BankFormRaise: NullArgument–bank_record_typesisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurredRaise: Unsupported– unable to get form for requested record types
AssessmentManager.create_bank(bank_form)¶Creates a new
Bank.
Parameters: bank_form ( osid.assessment.BankForm) – the form for thisBankReturns: the new BankReturn type: osid.assessment.BankRaise: IllegalState–bank_formalready used in a create transactionRaise: InvalidArgument– one or more of the form elements is invalidRaise: NullArgument–bank_formisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurredRaise: Unsupported–bank_formdid not originate fromget_bank_form_for_create()
AssessmentManager.can_update_banks()¶Tests if this user can update
Banks. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating aBankwill result in aPermissionDenied. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Returns: falseifBankmodification is not authorized,trueotherwiseReturn type: boolean
AssessmentManager.get_bank_form_for_update(bank_id)¶Gets the bank form for updating an existing bank. A new bank form should be requested for each update transaction.
Parameters: bank_id ( osid.id.Id) – theIdof theBankReturns: the bank form Return type: osid.assessment.BankFormRaise: NotFound–bank_idis not foundRaise: NullArgument–bank_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.update_bank(bank_form)¶Updates an existing bank.
Parameters: bank_form ( osid.assessment.BankForm) – the form containing the elements to be updatedRaise: IllegalState–bank_formalready used in an update transactionRaise: InvalidArgument– the form contains an invalid valueRaise: NullArgument–bank_formisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurredRaise: Unsupported–bank_formdid not originate fromget_bank_form_for_update()
AssessmentManager.can_delete_banks()¶Tests if this user can delete banks. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a
Bankwill result in aPermissionDenied. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Returns: falseifBankdeletion is not authorized,trueotherwiseReturn type: boolean
AssessmentManager.delete_bank(bank_id)¶Deletes a
Bank.
Parameters: bank_id ( osid.id.Id) – theIdof theBankto removeRaise: NotFound–bank_idnot foundRaise: NullArgument–bank_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.can_manage_bank_aliases()¶Tests if this user can manage
Idaliases forBanks. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in aPermissionDenied. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Returns: falseifBankaliasing is not authorized,trueotherwiseReturn type: boolean
AssessmentManager.alias_bank(bank_id, alias_id)¶Adds an
Idto aBankfor the purpose of creating compatibility. The primaryIdof theBankis determined by the provider. The newIdis an alias to the primaryId. If the alias is a pointer to another bank, it is reassigned to the given bankId.
Parameters:
- bank_id (
osid.id.Id) – theIdof aBank- alias_id (
osid.id.Id) – the aliasIdRaise:
AlreadyExists–alias_idis in use as a primaryIdRaise:
NotFound–bank_idnot foundRaise:
NullArgument–bank_idoralias_idisnullRaise:
OperationFailed– unable to complete requestRaise:
PermissionDenied– authorization failure occurred
Bank Hierarchy Methods¶
AssessmentManager.bank_hierarchy_id¶Gets the hierarchy
Idassociated with this session.
Returns: the hierarchy Idassociated with this sessionReturn type: osid.id.Id
AssessmentManager.bank_hierarchy¶Gets the hierarchy associated with this session.
Returns: the hierarchy associated with this session Return type: osid.hierarchy.HierarchyRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– assessment failure
AssessmentManager.can_access_bank_hierarchy()¶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
PermissionDenied. This is intended as a hint to an application that may opt not to offer lookup operations.
Returns: falseif hierarchy traversal methods are not authorized,trueotherwiseReturn type: boolean
AssessmentManager.use_comparative_bank_view()The returns from the lookup 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.
AssessmentManager.use_plenary_bank_view()A complete view of the
Bankreturns 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.
AssessmentManager.root_bank_ids¶Gets the root bank
Idsin this hierarchy.
Returns: the root bank IdsReturn type: osid.id.IdListRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.root_banks¶Gets the root banks in this bank hierarchy.
Returns: the root banks Return type: osid.assessment.BankListRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.has_parent_banks(bank_id)¶Tests if the
Bankhas any parents.
Parameters: bank_id ( osid.id.Id) – a bankIdReturns: trueif the bank has parents,falseotherwiseReturn type: booleanRaise: NotFound–bank_idis not foundRaise: NullArgument–bank_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.is_parent_of_bank(id_, bank_id)¶Tests if an
Idis a direct parent of a bank.
Parameters:
- id (
osid.id.Id) – anId- bank_id (
osid.id.Id) – theIdof a bankReturns:
trueif thisidis a parent ofbank_id,falseotherwiseReturn type:
booleanRaise:
NotFound–bank_idis not foundRaise:
NullArgument–idorbank_idisnullRaise:
OperationFailed– unable to complete requestRaise:
PermissionDenied– authorization failure occurred
AssessmentManager.get_parent_bank_ids(bank_id)¶Gets the parent
Idsof the given bank.
Parameters: bank_id ( osid.id.Id) – a bankIdReturns: the parent Idsof the bankReturn type: osid.id.IdListRaise: NotFound–bank_idis not foundRaise: NullArgument–bank_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.get_parent_banks(bank_id)¶Gets the parents of the given bank.
Parameters: bank_id ( osid.id.Id) – a bankIdReturns: the parents of the bank Return type: osid.assessment.BankListRaise: NotFound–bank_idis not foundRaise: NullArgument–bank_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.is_ancestor_of_bank(id_, bank_id)¶Tests if an
Idis an ancestor of a bank.
Parameters:
- id (
osid.id.Id) – anId- bank_id (
osid.id.Id) – theIdof a bankReturns:
trueif thisidis an ancestor ofbank_id,falseotherwiseReturn type:
booleanRaise:
NotFound–bank_idis not foundRaise:
NullArgument–bank_idisnullRaise:
OperationFailed– unable to complete requestRaise:
PermissionDenied– authorization failure
AssessmentManager.has_child_banks(bank_id)¶Tests if a bank has any children.
Parameters: bank_id ( osid.id.Id) – abank_idReturns: trueif thebank_idhas children,falseotherwiseReturn type: booleanRaise: NotFound–bank_idis not foundRaise: NullArgument–bank_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure
AssessmentManager.is_child_of_bank(id_, bank_id)¶Tests if a bank is a direct child of another.
Parameters:
- id (
osid.id.Id) – anId- bank_id (
osid.id.Id) – theIdof a bankReturns:
trueif theidis a child ofbank_id,falseotherwiseReturn type:
booleanRaise:
NotFound–bank_idnot foundRaise:
NullArgument–bank_idoridisnullRaise:
OperationFailed– unable to complete requestRaise:
PermissionDenied– authorization failure
AssessmentManager.get_child_bank_ids(bank_id)¶Gets the child
Idsof the given bank.
Parameters: bank_id ( osid.id.Id) – theIdto queryReturns: the children of the bank Return type: osid.id.IdListRaise: NotFound–bank_idis not foundRaise: NullArgument–bank_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure
AssessmentManager.get_child_banks(bank_id)¶Gets the children of the given bank.
Parameters: bank_id ( osid.id.Id) – theIdto queryReturns: the children of the bank Return type: osid.assessment.BankListRaise: NotFound–bank_idis not foundRaise: NullArgument–bank_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure
AssessmentManager.is_descendant_of_bank(id_, bank_id)¶Tests if an
Idis a descendant of a bank.
Parameters:
- id (
osid.id.Id) – anId- bank_id (
osid.id.Id) – theIdof a bankReturns:
trueif theidis a descendant of thebank_id,falseotherwiseReturn type:
booleanRaise:
NotFound–bank_idnot foundRaise:
NullArgument–bank_idoridisnullRaise:
OperationFailed– unable to complete requestRaise:
PermissionDenied– authorization failure
AssessmentManager.get_bank_node_ids(bank_id, ancestor_levels, descendant_levels, include_siblings)¶Gets a portion of the hierarchy for the given bank.
Parameters:
- bank_id (
osid.id.Id) – theIdto query- ancestor_levels (
cardinal) – the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.- descendant_levels (
cardinal) – the maximum number of descendant levels to include. A value of 0 returns no children in the node.- include_siblings (
boolean) –trueto include the siblings of the given node,falseto omit the siblingsReturns: a bank node
Return type:
osid.hierarchy.NodeRaise:
NotFound–bank_idis not foundRaise:
NullArgument–bank_idisnullRaise:
OperationFailed– unable to complete requestRaise:
PermissionDenied– authorization failure
AssessmentManager.get_bank_nodes(bank_id, ancestor_levels, descendant_levels, include_siblings)¶Gets a portion of the hierarchy for the given bank.
Parameters:
- bank_id (
osid.id.Id) – theIdto query- ancestor_levels (
cardinal) – the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.- descendant_levels (
cardinal) – the maximum number of descendant levels to include. A value of 0 returns no children in the node.- include_siblings (
boolean) –trueto include the siblings of the given node,falseto omit the siblingsReturns: a bank node
Return type:
osid.assessment.BankNodeRaise:
NotFound–bank_idis not foundRaise:
NullArgument–bank_idisnullRaise:
OperationFailed– unable to complete requestRaise:
PermissionDenied– authorization failure
Bank Hierarchy Design Methods¶
AssessmentManager.bank_hierarchy_idGets the hierarchy
Idassociated with this session.
Returns: the hierarchy Idassociated with this sessionReturn type: osid.id.Id
AssessmentManager.bank_hierarchyGets the hierarchy associated with this session.
Returns: the hierarchy associated with this session Return type: osid.hierarchy.HierarchyRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– assessment failure
AssessmentManager.can_modify_bank_hierarchy()¶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
PermissionDenied. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.
Returns: falseif changing this hierarchy is not authorized,trueotherwiseReturn type: boolean
AssessmentManager.add_root_bank(bank_id)¶Adds a root bank.
Parameters: bank_id ( osid.id.Id) – theIdof a bankRaise: AlreadyExists–bank_idis already in hierarchyRaise: NotFound–bank_idnot foundRaise: NullArgument–bank_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred
AssessmentManager.remove_root_bank(bank_id)¶Removes a root bank from this hierarchy.
Parameters: bank_id ( osid.id.Id) – theIdof a bankRaise: NotFound–bank_idnot a parent ofchild_idRaise: NullArgument–bank_idorchild_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure
AssessmentManager.add_child_bank(bank_id, child_id)¶Adds a child to a bank.
Parameters:
- bank_id (
osid.id.Id) – theIdof a bank- child_id (
osid.id.Id) – theIdof the new childRaise:
AlreadyExists–bank_idis already a parent ofchild_idRaise:
NotFound–bank_idorchild_idnot foundRaise:
NullArgument–bank_idorchild_idisnullRaise:
OperationFailed– unable to complete requestRaise:
PermissionDenied– authorization failure occurred
AssessmentManager.remove_child_bank(bank_id, child_id)¶Removes a child from a bank.
Parameters:
- bank_id (
osid.id.Id) – theIdof a bank- child_id (
osid.id.Id) – theIdof the new childRaise:
NotFound–bank_idnot parent ofchild_idRaise:
NullArgument–bank_idorchild_idisnullRaise:
OperationFailed– unable to complete requestRaise:
PermissionDenied– authorization failure occurred
AssessmentManager.remove_child_banks(bank_id)¶Removes all children from a bank.
Parameters: bank_id ( osid.id.Id) – theIdof a bankRaise: NotFound–bank_idis not in hierarchyRaise: NullArgument–bank_idisnullRaise: OperationFailed– unable to complete requestRaise: PermissionDenied– authorization failure occurred