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 anItem
questionAssessment
: a set ofItems
AssessmentSection:
A grouped set ofItems
AssessmentOffering:
AnAssessment
available for takingAssessmentTaken:
AnAssessmentOffering
that 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.AssessmentProfile
Gets an
AssessmentAuthoringManager
.Returns: an AssessmentAuthoringManager
Return type: osid.assessment.authoring.AssessmentAuthoringManager
Raise: OperationFailed
– unable to complete requestRaise: Unimplemented
–supports_assessment_authoring() is false
-
assessment_batch_manager
¶ Gets an
AssessmentBatchManager
.Returns: an AssessmentBatchManager
Return type: osid.assessment.batch.AssessmentBatchManager
Raise: 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: true
if assessment is supported,false
otherwiseReturn 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: true
if item query is supported,false
otherwiseReturn type: boolean
AssessmentManager.
supports_item_admin
()¶Tests if an item administrative service is supported.
Returns: true
if item admin is supported,false
otherwiseReturn 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: true
if assessment query is supported,false
otherwiseReturn type: boolean
AssessmentManager.
supports_assessment_admin
()¶Tests if an assessment administrative service is supported.
Returns: true
if assessment admin is supported,false
otherwiseReturn type: boolean
Tests if an assessment basic authoring session is available.
Returns: true
if assessment basic authoring is supported,false
otherwiseReturn 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: true
if assessment offered query is supported,false
otherwiseReturn type: boolean
AssessmentManager.
supports_assessment_offered_admin
()¶Tests if an assessment offered administrative service is supported.
Returns: true
if assessment offered admin is supported,false
otherwiseReturn type: boolean
AssessmentManager.
supports_assessment_taken_lookup
()¶Tests if an assessment taken lookup service is supported.
Returns: true
if assessment taken lookup is supported,false
otherwiseReturn type: boolean
AssessmentManager.
supports_assessment_taken_query
()¶Tests if an assessment taken query service is supported.
Returns: true
if assessment taken query is supported,false
otherwiseReturn 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: true
if assessment taken admin is supported,false
otherwiseReturn 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: true
if bank lookup is supported,false
otherwiseReturn type: boolean
AssessmentManager.
supports_bank_admin
()¶Tests if a banlk administrative service is supported.
Returns: true
if bank admin is supported,false
otherwiseReturn type: boolean
AssessmentManager.
supports_bank_hierarchy
()¶Tests if a bank hierarchy traversal is supported.
Returns: true
if a bank hierarchy traversal is supported,false
otherwiseReturn type: boolean
AssessmentManager.
supports_bank_hierarchy_design
()¶Tests if bank hierarchy design is supported.
Returns: true
if a bank hierarchy design is supported,false
otherwiseReturn type: boolean
AssessmentManager.
item_record_types
¶Gets the supported
Item
record types.
Returns: a list containing the supported Item
record typesReturn type: osid.type.TypeList
AssessmentManager.
item_search_record_types
¶Gets the supported
Item
search record types.
Returns: a list containing the supported Item
search record typesReturn type: osid.type.TypeList
AssessmentManager.
assessment_record_types
¶Gets the supported
Assessment
record types.
Returns: a list containing the supported Assessment
record typesReturn type: osid.type.TypeList
AssessmentManager.
assessment_search_record_types
¶Gets the supported
Assessment
search 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
AssessmentOffered
record types.
Returns: a list containing the supported AssessmentOffered
record typesReturn type: osid.type.TypeList
AssessmentManager.
assessment_offered_search_record_types
¶Gets the supported
AssessmentOffered
search record types.
Returns: a list containing the supported AssessmentOffered
search record typesReturn type: osid.type.TypeList
AssessmentManager.
assessment_taken_record_types
¶Gets the supported
AssessmentTaken
record types.
Returns: a list containing the supported AssessmentTaken
record typesReturn type: osid.type.TypeList
AssessmentManager.
assessment_taken_search_record_types
¶Gets the supported
AssessmentTaken
search record types.
Returns: a list containing the supported AssessmentTaken
search record typesReturn type: osid.type.TypeList
AssessmentManager.
assessment_section_record_types
¶Gets the supported
AssessmentSection
record types.
Returns: a list containing the supported AssessmentSection
record typesReturn type: osid.type.TypeList
AssessmentManager.
bank_record_types
¶Gets the supported
Bank
record types.
Returns: a list containing the supported Bank
record typesReturn type: osid.type.TypeList
AssessmentManager.
bank_search_record_types
¶Gets the supported bank search record types.
Returns: a list containing the supported Bank
search record typesReturn type: osid.type.TypeList
Bank Lookup Methods¶
AssessmentManager.
can_lookup_banks
()¶Tests if this user can perform
Bank
lookups. 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: false
if lookup methods are not authorized,true
otherwiseReturn 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
Bank
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.
AssessmentManager.
get_banks_by_ids
(bank_ids)¶Gets a
BankList
corresponding to the givenIdList
. In plenary mode, the returned list contains all of the banks specified in theId
list, in the order of the list, including duplicates, or an error results if anId
in the supplied list is not found or inaccessible. Otherwise, inaccessibleBank
objects 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 ofIds
to retrieveReturns: the returned Bank
listReturn type: osid.assessment.BankList
Raise: NotFound
– anId was
not foundRaise: NullArgument
–bank_ids
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurred
AssessmentManager.
get_banks_by_genus_type
(bank_genus_type)¶Gets a
BankList
corresponding to the given bank genusType
which 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 Bank
listReturn type: osid.assessment.BankList
Raise: NullArgument
–bank_genus_type
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurred
AssessmentManager.
get_banks_by_parent_genus_type
(bank_genus_type)¶Gets a
BankList
corresponding to the given bank genusType
and 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 Bank
listReturn type: osid.assessment.BankList
Raise: NullArgument
–bank_genus_type
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurred
AssessmentManager.
get_banks_by_record_type
(bank_record_type)¶Gets a
BankList
containing 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 Bank
listReturn type: osid.assessment.BankList
Raise: NullArgument
–bank_record_type
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurred
AssessmentManager.
get_banks_by_provider
(resource_id)¶Gets a
BankList
from 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 resourceId
Returns: the returned Bank
listReturn type: osid.assessment.BankList
Raise: NullArgument
–resource_id
isnull
Raise: 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 BankList
Return type: osid.assessment.BankList
Raise: 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 aBank
will result in aPermissionDenied
. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Returns: false
ifBank
creation is not authorized,true
otherwiseReturn type: boolean
AssessmentManager.
can_create_bank_with_record_types
(bank_record_types)¶Tests if this user can create a single
Bank
using 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 aBank
can be created with no records.
Parameters: bank_record_types ( osid.type.Type[]
) – array of bank record typesReturns: true
ifBank
creation using the specifiedTypes
is supported,false
otherwiseReturn type: boolean
Raise: NullArgument
–bank_record_types
isnull
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.BankForm
Raise: NullArgument
–bank_record_types
isnull
Raise: 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 thisBank
Returns: the new Bank
Return type: osid.assessment.Bank
Raise: IllegalState
–bank_form
already used in a create transactionRaise: InvalidArgument
– one or more of the form elements is invalidRaise: NullArgument
–bank_form
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurredRaise: Unsupported
–bank_form
did 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 aBank
will result in aPermissionDenied
. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Returns: false
ifBank
modification is not authorized,true
otherwiseReturn 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
) – theId
of theBank
Returns: the bank form Return type: osid.assessment.BankForm
Raise: NotFound
–bank_id
is not foundRaise: NullArgument
–bank_id
isnull
Raise: 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_form
already used in an update transactionRaise: InvalidArgument
– the form contains an invalid valueRaise: NullArgument
–bank_form
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurredRaise: Unsupported
–bank_form
did 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
Bank
will result in aPermissionDenied
. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Returns: false
ifBank
deletion is not authorized,true
otherwiseReturn type: boolean
AssessmentManager.
delete_bank
(bank_id)¶Deletes a
Bank
.
Parameters: bank_id ( osid.id.Id
) – theId
of theBank
to removeRaise: NotFound
–bank_id
not foundRaise: NullArgument
–bank_id
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurred
AssessmentManager.
can_manage_bank_aliases
()¶Tests if this user can manage
Id
aliases 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: false
ifBank
aliasing is not authorized,true
otherwiseReturn type: boolean
AssessmentManager.
alias_bank
(bank_id, alias_id)¶Adds an
Id
to aBank
for the purpose of creating compatibility. The primaryId
of theBank
is determined by the provider. The newId
is 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
) – theId
of aBank
- alias_id (
osid.id.Id
) – the aliasId
Raise:
AlreadyExists
–alias_id
is in use as a primaryId
Raise:
NotFound
–bank_id
not foundRaise:
NullArgument
–bank_id
oralias_id
isnull
Raise:
OperationFailed
– unable to complete requestRaise:
PermissionDenied
– authorization failure occurred
Bank Hierarchy Methods¶
AssessmentManager.
bank_hierarchy_id
¶Gets the hierarchy
Id
associated with this session.
Returns: the hierarchy Id
associated 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.Hierarchy
Raise: 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: false
if hierarchy traversal methods are not authorized,true
otherwiseReturn 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
Bank
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.
AssessmentManager.
root_bank_ids
¶Gets the root bank
Ids
in this hierarchy.
Returns: the root bank Ids
Return type: osid.id.IdList
Raise: 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.BankList
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurred
AssessmentManager.
has_parent_banks
(bank_id)¶Tests if the
Bank
has any parents.
Parameters: bank_id ( osid.id.Id
) – a bankId
Returns: true
if the bank has parents,false
otherwiseReturn type: boolean
Raise: NotFound
–bank_id
is not foundRaise: NullArgument
–bank_id
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurred
AssessmentManager.
is_parent_of_bank
(id_, bank_id)¶Tests if an
Id
is a direct parent of a bank.
Parameters:
- id (
osid.id.Id
) – anId
- bank_id (
osid.id.Id
) – theId
of a bankReturns:
true
if thisid
is a parent ofbank_id,
false
otherwiseReturn type:
boolean
Raise:
NotFound
–bank_id
is not foundRaise:
NullArgument
–id
orbank_id
isnull
Raise:
OperationFailed
– unable to complete requestRaise:
PermissionDenied
– authorization failure occurred
AssessmentManager.
get_parent_bank_ids
(bank_id)¶Gets the parent
Ids
of the given bank.
Parameters: bank_id ( osid.id.Id
) – a bankId
Returns: the parent Ids
of the bankReturn type: osid.id.IdList
Raise: NotFound
–bank_id
is not foundRaise: NullArgument
–bank_id
isnull
Raise: 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 bankId
Returns: the parents of the bank Return type: osid.assessment.BankList
Raise: NotFound
–bank_id
is not foundRaise: NullArgument
–bank_id
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurred
AssessmentManager.
is_ancestor_of_bank
(id_, bank_id)¶Tests if an
Id
is an ancestor of a bank.
Parameters:
- id (
osid.id.Id
) – anId
- bank_id (
osid.id.Id
) – theId
of a bankReturns:
true
if thisid
is an ancestor ofbank_id,
false
otherwiseReturn type:
boolean
Raise:
NotFound
–bank_id
is not foundRaise:
NullArgument
–bank_id
isnull
Raise:
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_id
Returns: true
if thebank_id
has children,false
otherwiseReturn type: boolean
Raise: NotFound
–bank_id
is not foundRaise: NullArgument
–bank_id
isnull
Raise: 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
) – theId
of a bankReturns:
true
if theid
is a child ofbank_id,
false
otherwiseReturn type:
boolean
Raise:
NotFound
–bank_id
not foundRaise:
NullArgument
–bank_id
orid
isnull
Raise:
OperationFailed
– unable to complete requestRaise:
PermissionDenied
– authorization failure
AssessmentManager.
get_child_bank_ids
(bank_id)¶Gets the child
Ids
of the given bank.
Parameters: bank_id ( osid.id.Id
) – theId
to queryReturns: the children of the bank Return type: osid.id.IdList
Raise: NotFound
–bank_id
is not foundRaise: NullArgument
–bank_id
isnull
Raise: 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
) – theId
to queryReturns: the children of the bank Return type: osid.assessment.BankList
Raise: NotFound
–bank_id
is not foundRaise: NullArgument
–bank_id
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure
AssessmentManager.
is_descendant_of_bank
(id_, bank_id)¶Tests if an
Id
is a descendant of a bank.
Parameters:
- id (
osid.id.Id
) – anId
- bank_id (
osid.id.Id
) – theId
of a bankReturns:
true
if theid
is a descendant of thebank_id,
false
otherwiseReturn type:
boolean
Raise:
NotFound
–bank_id
not foundRaise:
NullArgument
–bank_id
orid
isnull
Raise:
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
) – theId
to 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
) –true
to include the siblings of the given node,false
to omit the siblingsReturns: a bank node
Return type:
osid.hierarchy.Node
Raise:
NotFound
–bank_id
is not foundRaise:
NullArgument
–bank_id
isnull
Raise:
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
) – theId
to 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
) –true
to include the siblings of the given node,false
to omit the siblingsReturns: a bank node
Return type:
osid.assessment.BankNode
Raise:
NotFound
–bank_id
is not foundRaise:
NullArgument
–bank_id
isnull
Raise:
OperationFailed
– unable to complete requestRaise:
PermissionDenied
– authorization failure
Bank Hierarchy Design Methods¶
AssessmentManager.
bank_hierarchy_id
Gets the hierarchy
Id
associated with this session.
Returns: the hierarchy Id
associated 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.Hierarchy
Raise: 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: false
if changing this hierarchy is not authorized,true
otherwiseReturn type: boolean
AssessmentManager.
add_root_bank
(bank_id)¶Adds a root bank.
Parameters: bank_id ( osid.id.Id
) – theId
of a bankRaise: AlreadyExists
–bank_id
is already in hierarchyRaise: NotFound
–bank_id
not foundRaise: NullArgument
–bank_id
isnull
Raise: 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
) – theId
of a bankRaise: NotFound
–bank_id
not a parent ofchild_id
Raise: NullArgument
–bank_id
orchild_id
isnull
Raise: 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
) – theId
of a bank- child_id (
osid.id.Id
) – theId
of the new childRaise:
AlreadyExists
–bank_id
is already a parent ofchild_id
Raise:
NotFound
–bank_id
orchild_id
not foundRaise:
NullArgument
–bank_id
orchild_id
isnull
Raise:
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
) – theId
of a bank- child_id (
osid.id.Id
) – theId
of the new childRaise:
NotFound
–bank_id
not parent ofchild_id
Raise:
NullArgument
–bank_id
orchild_id
isnull
Raise:
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
) – theId
of a bankRaise: NotFound
–bank_id
is not in hierarchyRaise: NullArgument
–bank_id
isnull
Raise: OperationFailed
– unable to complete requestRaise: PermissionDenied
– authorization failure occurred