Bank

Bank

class dlkit.services.assessment.Bank(provider_manager, catalog, runtime, proxy, **kwargs)

Bases: dlkit.osid.objects.OsidCatalog, dlkit.osid.sessions.OsidSession

A bank defines a collection of assessments and items.

get_bank_record(bank_record_type)

Gets the bank record corresponding to the given Bank record Type.

This method is used to retrieve an object implementing the requested record. The bank_record_type may be the Type returned in get_record_types() or any of its parents in a Type hierarchy where has_record_type(bank_record_type) is true .

Parameters:bank_record_type (osid.type.Type) – a bank record type Returns:the bank record Return type:osid.assessment.records.BankRecord Raise:NullArgument – bank_record_type is null Raise:OperationFailed – unable to complete request Raise:Unsupported – has_record_type(bank_record_type) is false

compliance: mandatory – This method must be implemented.

Assessment Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_take_assessments()

Tests if this user can take this assessment section.

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 assessment operations to unauthorized users.

Returns:false if assessment methods are not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.has_assessment_begun(assessment_taken_id)

Tests if this assessment has started.

An assessment begins from the designated start time if a start time is defined. If no start time is defined the assessment may begin at any time. Assessment sections cannot be accessed if the return for this method is false.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:true if this assessment has begun, false otherwise Return type:boolean Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.is_assessment_over(assessment_taken_id)

Tests if this assessment is over.

An assessment is over if finished_assessment() is invoked or the designated finish time has expired.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:true if this assessment is over, false otherwise Return type:boolean Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.requires_synchronous_sections(assessment_taken_id)

Tests if synchronous sections are required.

This method should be checked to determine if all sections are available when requested, or the next sections becomes available only after the previous section is complete.

There are two methods for retrieving sections. One is using the built-in hasNextSection() and getNextSection() methods. In synchronous mode, hasNextSection() is false until the current section is completed. In asynchronous mode, has_next_section() returns true until the end of the assessment.

AssessmentSections may also be accessed via an AssessmentSectionList. If syncronous sections are required, AssessmentSectionList.available() == 0 and AssessmentSectionList.getNextQuestion() blocks until the section is complete. AssessmentSectionList.hasNext() is always true until the end of the assessment is reached.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:true if this synchronous sections are required, false otherwise Return type:boolean Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_first_assessment_section(assessment_taken_id)

Gets the first assessment section in this assesment.

All assessments have at least one AssessmentSection.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:the first assessment section Return type:osid.assessment.AssessmentSection Raise:IllegalState – has_assessment_begun() is false Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.has_next_assessment_section(assessment_section_id)

Tests if there is a next assessment section in the assessment following the given assessment section Id.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:true if there is a next section, false otherwise Return type:boolean Raise:IllegalState – has_assessment_begun() is false Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_next_assessment_section(assessment_section_id)

Gets the next assessemnt section following the given assesment section.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:the next section Return type:osid.assessment.AssessmentSection Raise:IllegalState – has_next_assessment_section() is false Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.has_previous_assessment_section(assessment_section_id)

Tests if there is a previous assessment section in the assessment following the given assessment section Id.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:true if there is a previous assessment section, false otherwise Return type:boolean Raise:IllegalState – has_assessment_begun() is false Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_previous_assessment_section(assessment_section_id)

Gets the next assessemnt section following the given assesment section.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:the previous assessment section Return type:osid.assessment.AssessmentSection Raise:IllegalState – has_next_assessment_section() is false Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessment_section(assessment_section_id)

Gets an assessemnts section by Id.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:the assessment section Return type:osid.assessment.AssessmentSection Raise:IllegalState – has_assessment_begun() is false Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessment_sections(assessment_taken_id)

Gets the assessment sections of this assessment.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:the list of assessment sections Return type:osid.assessment.AssessmentSectionList Raise:IllegalState – has_assessment_begun() is false Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.is_assessment_section_complete(assessment_section_id)

Tests if the all responses have been submitted to this assessment section.

If is_assessment_section_complete() is false, then get_unanswered_questions() may return a list of questions that can be submitted.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:true if this assessment section is complete, false otherwise Return type:boolean Raise:IllegalState – is_assessment_over() is true Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.get_incomplete_assessment_sections(assessment_taken_id)

Gets the incomplete assessment sections of this assessment.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:the list of incomplete assessment sections Return type:osid.assessment.AssessmentSectionList Raise:IllegalState – has_assessment_begun() is false Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.has_assessment_section_begun(assessment_section_id)

Tests if this assessment section has started.

A section begins from the designated start time if a start time is defined. If no start time is defined the section may begin at any time. Assessment items cannot be accessed or submitted if the return for this method is false.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:true if this assessment section has begun, false otherwise Return type:boolean Raise:IllegalState – has_assessment_begun() is false or is_assessment_over() is true Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.is_assessment_section_over(assessment_section_id)

Tests if this assessment section is over.

An assessment section is over if new or updated responses can not be submitted such as the designated finish time has expired.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:true if this assessment is over, false otherwise Return type:boolean Raise:IllegalState – has_assessmen_sectiont_begun() is false or is_assessment_section_over() is true Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.requires_synchronous_responses(assessment_section_id)

Tests if synchronous responses are required in this assessment section.

This method should be checked to determine if all items are available when requested, or the next item becomes available only after the response to the current item is submitted.

There are two methods for retrieving questions. One is using the built-in has_next_question() and get_next_question() methods. In synchronous mode, has_next_question() is false until the response for the current question is submitted. In asynchronous mode, has_next_question() returns true until the end of the assessment.

Questions may also be accessed via a QuestionList. If syncronous responses are required, QuestionList.available() == 0 and QuestionList.getNextQuestion() blocks until the response is submitted. QuestionList.hasNext() is always true until the end of the assessment is reached.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:true if this synchronous responses are required, false otherwise Return type:boolean Raise:IllegalState – has_assessment_begun() is false or is_assessment_over() is true Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.get_first_question(assessment_section_id)

Gets the first question in this assesment section.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:the first question Return type:osid.assessment.Question Raise:IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.has_next_question(assessment_section_id, item_id)

Tests if there is a next question following the given question Id.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

true if there is a next question, false otherwise

Return type:

boolean

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_next_question(assessment_section_id, item_id)

Gets the next question in this assesment section.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

the next question

Return type:

osid.assessment.Question

Raise:

IllegalState – has_next_question() is false

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.has_previous_question(assessment_section_id, item_id)

Tests if there is a previous question preceeding the given question Id.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

true if there is a previous question, false otherwise

Return type:

boolean

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_previous_question(assessment_section_id, item_id)

Gets the previous question in this assesment section.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

the previous question

Return type:

osid.assessment.Question

Raise:

IllegalState – has_previous_question() is false

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_question(assessment_section_id, item_id)

Gets the Question specified by its Id.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

the returned Question

Return type:

osid.assessment.Question

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_questions(assessment_section_id)

Gets the questions of this assessment section.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:the list of assessment questions Return type:osid.assessment.QuestionList Raise:IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_response_form(assessment_section_id, item_id)

Gets the response form for submitting an answer.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

an answer form

Return type:

osid.assessment.AnswerForm

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.submit_response(assessment_section_id, item_id, answer_form)

Submits an answer to an item.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item
• answer_form (osid.assessment.AnswerForm) – the response

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

InvalidArgument – one or more of the elements in the form is invalid

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id, item_id, or answer_form is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

Raise:

Unsupported – answer_form is not of this service

compliance: mandatory – This method must be implemented.

Bank.skip_item(assessment_section_id, item_id)

Skips an item.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.is_question_answered(assessment_section_id, item_id)

Tests if the given item has a response.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

true if this item has a response, false otherwise

Return type:

boolean

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.get_unanswered_questions(assessment_section_id)

Gets the unanswered questions of this assessment section.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:the list of questions with no rsponses Return type:osid.assessment.QuestionList Raise:IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.has_unanswered_questions(assessment_section_id)

Tests if there are unanswered questions in this assessment section.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:true if there are unanswered questions, false otherwise Return type:boolean Raise:IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_first_unanswered_question(assessment_section_id)

Gets the first unanswered question in this assesment section.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Returns:the first unanswered question Return type:osid.assessment.Question Raise:IllegalState – has_unanswered_questions() is false Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.has_next_unanswered_question(assessment_section_id, item_id)

Tests if there is a next unanswered question following the given question Id.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

true if there is a next unanswered question, false otherwise

Return type:

boolean

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_next_unanswered_question(assessment_section_id, item_id)

Gets the next unanswered question in this assesment section.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

the next unanswered question

Return type:

osid.assessment.Question

Raise:

IllegalState – has_next_unanswered_question() is false

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.has_previous_unanswered_question(assessment_section_id, item_id)

Tests if there is a previous unanswered question preceeding the given question Id.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

true if there is a previous unanswered question, false otherwise

Return type:

boolean

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_previous_unanswered_question(assessment_section_id, item_id)

Gets the previous unanswered question in this assesment section.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

the previous unanswered question

Return type:

osid.assessment.Question

Raise:

IllegalState – has_previous_unanswered_question() is false

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_response(assessment_section_id, item_id)

Gets the submitted response to the associated item.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

the response

Return type:

osid.assessment.Response

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.get_responses(assessment_taken_id)

Gets the submitted responses.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:the submitted answers Return type:osid.assessment.ResponseList Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.clear_response(assessment_section_id, item_id)

Clears the response to an item The item appears as unanswered.

If no response exists, the method simply returns.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Raise:

IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.finish_assessment_section(assessment_section_id)

Indicates an assessment section is complete.

Finished sections may or may not allow new or updated responses.

Parameters:assessment_section_id (osid.id.Id) – Id of the AssessmentSection Raise:IllegalState – has_assessment_section_begun() is false or is_assessment_section_over() is true Raise:NotFound – assessment_section_id is not found Raise:NullArgument – assessment_section_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.is_answer_available(assessment_section_id, item_id)

Tests if an answer is available for the given item.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

true if an answer are available, false otherwise

Return type:

boolean

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.get_answers(assessment_section_id, item_id)

Gets the acceptable answers to the associated item.

Parameters:

• assessment_section_id (osid.id.Id) – Id of the AssessmentSection
• item_id (osid.id.Id) – Id of the Item

Returns:

the answers

Return type:

osid.assessment.AnswerList

Raise:

IllegalState – is_answer_available() is false

Raise:

NotFound – assessment_section_id or item_id is not found, or item_id not part of assessment_section_id

Raise:

NullArgument – assessment_section_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.finish_assessment(assessment_taken_id)

Indicates the entire assessment is complete.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Raise:IllegalState – has_begun() is false or is_over() is true Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Assessment Results Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_access_assessment_results()

Tests if this user can take this assessment.

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 assessment operations to unauthorized users.

Returns:false if assessment methods are not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.get_items()

Gets all Items.

In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.

Returns:a list of Items Return type:osid.assessment.ItemList Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_responses(assessment_taken_id)

Gets the submitted responses.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:the submitted answers Return type:osid.assessment.ResponseList Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.are_results_available(assessment_taken_id)

Tests if the results are available for this assessment.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:true if results are available, false otherwise Return type:boolean Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.get_grade_entries(assessment_taken_id)

Gets a list of grade entries for this assessment.

Each grade entry may indicate a grade or score input by multiple graders.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:a list of grade entries Return type:osid.grading.GradeEntryList Raise:IllegalState – are_results_available() is false Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Item Lookup Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_lookup_items()

Tests if this user can perform Item 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 a PermissionDenied. This is intended as a hint to an application that may opt not to offer lookup operations.

Returns:false if lookup methods are not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.use_comparative_item_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.

compliance: mandatory – This method is must be implemented.

Bank.use_plenary_item_view()

A complete view of the Item 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.

compliance: mandatory – This method is must be implemented.

Bank.use_federated_bank_view()

Federates the view for methods in this session.

A federated view will include assessments taken in banks which are children of this bank in the bank hierarchy.

compliance: mandatory – This method is must be implemented.

Bank.use_isolated_bank_view()

Isolates the view for methods in this session.

An isolated view restricts searches to this bank only.

compliance: mandatory – This method is must be implemented.

Bank.get_item(item_id)

Gets the Item specified by its Id.

In plenary mode, the exact Id is found or a NotFound results. Otherwise, the returned Item may have a different Id than requested, such as the case where a duplicate Id was assigned to an Item and retained for compatibility.

Parameters:item_id (osid.id.Id) – the Id of the Item to retrieve Returns:the returned Item Return type:osid.assessment.Item Raise:NotFound – no Item found with the given Id Raise:NullArgument – item_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_items_by_ids(item_ids)

Gets an ItemList corresponding to the given IdList.

In plenary mode, the returned list contains all of the items specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Items may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:item_ids (osid.id.IdList) – the list of Ids to retrieve Returns:the returned Item list Return type:osid.assessment.ItemList Raise:NotFound – an Id was not found Raise:NullArgument – item_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_items_by_genus_type(item_genus_type)

Gets an ItemList corresponding to the given assessment item genus Type which does not include assessment items of genus types derived from the specified Type.

In plenary mode, the returned list contains all known assessment items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parameters:item_genus_type (osid.type.Type) – an assessment item genus type Returns:the returned Item list Return type:osid.assessment.ItemList Raise:NullArgument – item_genus_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_items_by_parent_genus_type(item_genus_type)

Gets an ItemList corresponding to the given assessment item genus Type and include any additional assessment items with genus types derived from the specified Type.

In plenary mode, the returned list contains all known assessment items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parameters:item_genus_type (osid.type.Type) – an assessment item genus type Returns:the returned Item list Return type:osid.assessment.ItemList Raise:NullArgument – item_genus_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_items_by_record_type(item_record_type)

Gets an ItemList containing the given assessment item record Type.

In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parameters:item_record_type (osid.type.Type) – an item record type Returns:the returned Item list Return type:osid.assessment.ItemList Raise:NullArgument – item_record_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_items_by_question(question_id)

Gets an ItemList containing the given question.

In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parameters:question_id (osid.id.Id) – a question Id Returns:the returned Item list Return type:osid.assessment.ItemList Raise:NullArgument – question_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_items_by_answer(answer_id)

Gets an ItemList containing the given answer.

In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parameters:answer_id (osid.id.Id) – an answer Id Returns:the returned Item list Return type:osid.assessment.ItemList Raise:NullArgument – answer_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_items_by_learning_objective(objective_id)

Gets an ItemList containing the given learning objective.

In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parameters:objective_id (osid.id.Id) – a learning objective Id Returns:the returned Item list Return type:osid.assessment.ItemList Raise:NullArgument – objective_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_items_by_learning_objectives(objective_ids)

Gets an ItemList containing the given learning objectives.

In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parameters:objective_ids (osid.id.IdList) – a list of learning objective Ids Returns:the returned Item list Return type:osid.assessment.ItemList Raise:NullArgument – objective_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.items

Gets all Items.

In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.

Returns:a list of Items Return type:osid.assessment.ItemList Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Item Query Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_search_items()

Tests if this user can perform Item searches.

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 pplication that may wish not to offer search operations to unauthorized users.

Returns:false if search methods are not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.use_federated_bank_view()

Federates the view for methods in this session.

A federated view will include assessments taken in banks which are children of this bank in the bank hierarchy.

compliance: mandatory – This method is must be implemented.

Bank.use_isolated_bank_view()

Isolates the view for methods in this session.

An isolated view restricts searches to this bank only.

compliance: mandatory – This method is must be implemented.

Bank.item_query

Gets an assessment item query.

Returns:the assessment item query Return type:osid.assessment.ItemQuery

compliance: mandatory – This method must be implemented.

Bank.get_items_by_query(item_query)

Gets a list of Items matching the given item query.

Parameters:item_query (osid.assessment.ItemQuery) – the item query Returns:the returned ItemList Return type:osid.assessment.ItemList Raise:NullArgument – item_query is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – item_query is not of this service

compliance: mandatory – This method must be implemented.

Item Search Methods

Bank.item_search

Gets an assessment item search.

Returns:the assessment item search Return type:osid.assessment.ItemSearch

compliance: mandatory – This method must be implemented.

Bank.item_search_order

Gets an assessment item search order.

The ItemSearchOrder is supplied to an ItemSearch to specify the ordering of results.

Returns:the assessment item search order Return type:osid.assessment.ItemSearchOrder

compliance: mandatory – This method must be implemented.

Bank.get_items_by_search(item_query, item_search)

Gets the search results matching the given search query using the given search.

Parameters:

• item_query (osid.assessment.ItemQuery) – the item query
• item_search (osid.assessment.ItemSearch) – the item search

Returns:

the returned search results

Return type:

osid.assessment.ItemSearchResults

Raise:

NullArgument – item_query or item_search is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

Raise:

Unsupported – item_search or item_query is not of this service

compliance: mandatory – This method must be implemented.

Bank.get_item_query_from_inspector(item_query_inspector)

Gets an item query from an inspector.

The inspector is available from an ItemSearchResults.

Parameters:item_query_inspector (osid.assessment.ItemQueryInspector) – a query inspector Returns:the item query Return type:osid.assessment.ItemQuery Raise:NullArgument – item_query_inspector is null Raise:Unsupported – item_query_inspector is not of this service

compliance: mandatory – This method must be implemented.

Item Admin Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_create_items()

Tests if this user can create Items.

A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Item will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:false if Item creation is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.can_create_item_with_record_types(item_record_types)

Tests if this user can create a single Item using the desired record types.

While AssessmentManager.getItemRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Item. Providing an empty array tests if an Item can be created with no records.

Parameters:item_record_types (osid.type.Type[]) – array of item record types Returns:true if Item creation using the specified record Types is supported, false otherwise Return type:boolean Raise:NullArgument – item_record_types is null

compliance: mandatory – This method must be implemented.

Bank.get_item_form_for_create(item_record_types)

Gets the assessment item form for creating new assessment items.

A new form should be requested for each create transaction.

Parameters:item_record_types (osid.type.Type[]) – array of item record types to be included in the create operation or an empty list if none Returns:the assessment item form Return type:osid.assessment.ItemForm Raise:NullArgument – item_record_types is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – unable to get form for requested record types

compliance: mandatory – This method must be implemented.

Bank.create_item(item_form)

Creates a new Item.

Parameters:item_form (osid.assessment.ItemForm) – the form for this Item Returns:the new Item Return type:osid.assessment.Item Raise:IllegalState – item_form already used in a create transaction Raise:InvalidArgument – one or more of the form elements is invalid Raise:NullArgument – item_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – item_form did not originate from get_item_form_for_create()

compliance: mandatory – This method must be implemented.

Bank.can_update_items()

Tests if this user can update Items.

A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an Item will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:false if assessment item modification is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.get_item_form_for_update(item_id)

Gets the assessment item form for updating an existing item.

A new item form should be requested for each update transaction.

Parameters:item_id (osid.id.Id) – the Id of the Item Returns:the assessment item form Return type:osid.assessment.ItemForm Raise:NotFound – item_id is not found Raise:NullArgument – item_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.update_item(item_form)

Updates an existing item.

Parameters:item_form (osid.assessment.ItemForm) – the form containing the elements to be updated Raise:IllegalState – item_form already used in an update transaction Raise:InvalidArgument – the form contains an invalid value Raise:NullArgument – item_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – item_form did not originate from get_item_form_for_update()

compliance: mandatory – This method must be implemented.

Bank.can_delete_items()

Tests if this user can delete Items.

A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an Item will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:false if Item deletion is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.delete_item(item_id)

Deletes the Item identified by the given Id.

Parameters:item_id (osid.id.Id) – the Id of the Item to delete Raise:NotFound – an Item was not found identified by the given Id Raise:NullArgument – item_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_manage_item_aliases()

Tests if this user can manage Id aliases for Items.

A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:false if Item aliasing is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.alias_item(item_id, alias_id)

Adds an Id to an Item for the purpose of creating compatibility.

The primary Id of the Item is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another item, it is reassigned to the given item Id.

Parameters:

• item_id (osid.id.Id) – the Id of an Item
• alias_id (osid.id.Id) – the alias Id

Raise:

AlreadyExists – alias_id is in use as a primary Id

Raise:

NotFound – item_id not found

Raise:

NullArgument – item_id or alias_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_create_questions()

Tests if this user can create Questions.

A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Question will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:false if Question creation is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.can_create_question_with_record_types(question_record_types)

Tests if this user can create a single Question using the desired record types.

While AssessmentManager.getQuestionRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Question. Providing an empty array tests if a Question can be created with no records.

Parameters:question_record_types (osid.type.Type[]) – array of question record types Returns:true if Question creation using the specified record Types is supported, false otherwise Return type:boolean Raise:NullArgument – question_record_types is null

compliance: mandatory – This method must be implemented.

Bank.get_question_form_for_create(item_id, question_record_types)

Gets the question form for creating new questions.

A new form should be requested for each create transaction.

Parameters:

• item_id (osid.id.Id) – an assessment item Id
• question_record_types (osid.type.Type[]) – array of question record types to be included in the create operation or an empty list if none

Returns:

the question form

Return type:

osid.assessment.QuestionForm

Raise:

NullArgument – question_record_types is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

Raise:

Unsupported – unable to get form for requested record types

compliance: mandatory – This method must be implemented.

Bank.create_question(question_form)

Creates a new Question.

Parameters:question_form (osid.assessment.QuestionForm) – the form for this Question Returns:the new Question Return type:osid.assessment.Question Raise:AlreadyExists – a question already exists for this item Raise:IllegalState – question_form already used in a create transaction Raise:InvalidArgument – one or more of the form elements is invalid Raise:NullArgument – question_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – question_form did not originate from get_question_form_for_create()

compliance: mandatory – This method must be implemented.

Bank.can_update_questions()

Tests if this user can update Questions.

A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Question will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:false if question modification is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.get_question_form_for_update(question_id)

Gets the question form for updating an existing question.

A new question form should be requested for each update transaction.

Parameters:question_id (osid.id.Id) – the Id of the Question Returns:the question form Return type:osid.assessment.QuestionForm Raise:NotFound – question_id is not found Raise:NullArgument – question_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.update_question(question_form)

Updates an existing question.

Parameters:question_form (osid.assessment.QuestionForm) – the form containing the elements to be updated Raise:IllegalState – question_form already used in an update transaction Raise:InvalidArgument – the form contains an invalid value Raise:NullArgument – question_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – question_form did not originate from get_question_form_for_update()

compliance: mandatory – This method must be implemented.

Bank.can_delete_questions()

Tests if this user can delete Questions.

A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Question will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:false if Question deletion is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.delete_question(question_id)

Deletes the Question identified by the given Id.

Parameters:question_id (osid.id.Id) – the Id of the Question to delete Raise:NotFound – a Question was not found identified by the given Id Raise:NullArgument – question_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_create_answers()

Tests if this user can create Answers.

A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Answer will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:false if Answer creation is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.can_create_answers_with_record_types(answer_record_types)

Tests if this user can create a single Answer using the desired record types.

While AssessmentManager.getAnswerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Answer. Providing an empty array tests if an Answer can be created with no records.

Parameters:answer_record_types (osid.type.Type[]) – array of answer record types Returns:true if Answer creation using the specified record Types is supported, false otherwise Return type:boolean Raise:NullArgument – answern_record_types is null

compliance: mandatory – This method must be implemented.

Bank.get_answer_form_for_create(item_id, answer_record_types)

Gets the answer form for creating new answers.

A new form should be requested for each create transaction.

Parameters:

• item_id (osid.id.Id) – an assessment item Id
• answer_record_types (osid.type.Type[]) – array of answer record types to be included in the create operation or an empty list if none

Returns:

the answer form

Return type:

osid.assessment.AnswerForm

Raise:

NullArgument – answer_record_types is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

Raise:

Unsupported – unable to get form for requested record types

compliance: mandatory – This method must be implemented.

Bank.create_answer(answer_form)

Creates a new Answer.

Parameters:answer_form (osid.assessment.AnswerForm) – the form for this Answer Returns:the new Answer Return type:osid.assessment.Answer Raise:IllegalState – answer_form already used in a create transaction Raise:InvalidArgument – one or more of the form elements is invalid Raise:NullArgument – answer_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – answer_form did not originate from get_answer_form_for_create()

compliance: mandatory – This method must be implemented.

Bank.can_update_answers()

Tests if this user can update Answers.

A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an Answer will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:false if answer modification is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.get_answer_form_for_update(answer_id)

Gets the answer form for updating an existing answer.

A new answer form should be requested for each update transaction.

Parameters:answer_id (osid.id.Id) – the Id of the Answer Returns:the answer form Return type:osid.assessment.AnswerForm Raise:NotFound – answer_id is not found Raise:NullArgument – answer_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.update_answer(answer_form)

Updates an existing answer.

Parameters:answer_form (osid.assessment.AnswerForm) – the form containing the elements to be updated Raise:IllegalState – answer_form already used in an update transaction Raise:InvalidArgument – the form contains an invalid value Raise:NullArgument – answer_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – answer_form did not originate from get_answer_form_for_update()

compliance: mandatory – This method must be implemented.

Bank.can_delete_answers()

Tests if this user can delete Answers.

A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an Answer will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:false if Answer deletion is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.delete_answer(answer_id)

Deletes the Answer identified by the given Id.

Parameters:answer_id (osid.id.Id) – the Id of the Answer to delete Raise:NotFound – an Answer was not found identified by the given Id Raise:NullArgument – answer_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Item Notification Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_register_for_item_notifications()

Tests if this user can register for Item notifications.

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 notification operations.

Returns:false if notification methods are not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.use_federated_bank_view()

Federates the view for methods in this session.

A federated view will include assessments taken in banks which are children of this bank in the bank hierarchy.

compliance: mandatory – This method is must be implemented.

Bank.use_isolated_bank_view()

Isolates the view for methods in this session.

An isolated view restricts searches to this bank only.

compliance: mandatory – This method is must be implemented.

Bank.reliable_item_notifications()

Reliable notifications are desired.

In reliable mode, notifications are to be acknowledged using acknowledge_item_notification() .

compliance: mandatory – This method is must be implemented.

Bank.unreliable_item_notifications()

Unreliable notifications are desired.

In unreliable mode, notifications do not need to be acknowledged.

compliance: mandatory – This method is must be implemented.

Bank.acknowledge_item_notification(notification_id)

Acknowledge an item notification.

Parameters:notification_id (osid.id.Id) – the Id of the notification Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Bank.register_for_new_items()

Register for notifications of new assessment items.

ItemReceiver.newItems() is invoked when a new Item is created.

Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.register_for_changed_items()

Registers for notification of updated assessment items.

ItemReceiver.changedItems() is invoked when an assessment item is changed.

Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.register_for_changed_item(item_id)

Registers for notification of an updated assessment item.

ItemReceiver.changedItems() is invoked when the specified assessment item is changed.

Parameters:item_id (osid.id.Id) – the Id of the Assessment to monitor Raise:NotFound – an item was not found identified by the given Id Raise:NullArgument – item_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.register_for_deleted_items()

Registers for notification of deleted assessment items.

ItemReceiver.deletedItems() is invoked when an assessment item is removed from the assessment bank.

Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.register_for_deleted_item(item_id)

Registers for notification of a deleted assessment item.

ItemReceiver.deletedItems() is invoked when the specified assessment item is removed from the assessment bank.

Parameters:item_id (osid.id.Id) – the Id of the Item to monitor Raise:NotFound – an Item was not found identified by the given Id Raise:NullArgument – item_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Item Bank Methods

Bank.can_lookup_item_bank_mappings()

Tests if this user can perform lookups of item/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 to unauthorized users.

Returns:false if looking up mappings is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.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.

compliance: mandatory – This method is must be implemented.

Bank.use_plenary_bank_view()

A complete view of the AssessmentTaken and 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.

compliance: mandatory – This method is must be implemented.

Bank.get_item_ids_by_bank(bank_id)

Gets the list of Item Ids associated with a Bank.

Parameters:bank_id (osid.id.Id) – Id of the Bank Returns:list of related item Ids Return type:osid.id.IdList Raise:NotFound – bank_id is not found Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_items_by_bank(bank_id)

Gets the list of Items associated with a Bank.

Parameters:bank_id (osid.id.Id) – Id of the Bank Returns:list of related items Return type:osid.assessment.ItemList Raise:NotFound – bank_id is not found Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_item_ids_by_banks(bank_ids)

Gets the list of Item Ids corresponding to a list of Banks.

Parameters:bank_ids (osid.id.IdList) – list of bank Ids Returns:list of bank Ids Return type:osid.id.IdList Raise:NullArgument – bank_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – assessment failure

compliance: mandatory – This method must be implemented.

Bank.get_items_by_banks(bank_ids)

Gets the list of Items corresponding to a list of Banks.

Parameters:bank_ids (osid.id.IdList) – list of bank Ids Returns:list of items Return type:osid.assessment.ItemList Raise:NullArgument – bank_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – assessment failure

compliance: mandatory – This method must be implemented.

Bank.get_bank_ids_by_item(item_id)

Gets the list of Bank Ids mapped to an Item.

Parameters:item_id (osid.id.Id) – Id of an Item Returns:list of bank Ids Return type:osid.id.IdList Raise:NotFound – item_id is not found Raise:NullArgument – item_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – assessment failure

compliance: mandatory – This method must be implemented.

Bank.get_banks_by_item(item_id)

Gets the list of Banks mapped to an Item.

Parameters:item_id (osid.id.Id) – Id of an Item Returns:list of banks Return type:osid.assessment.BankList Raise:NotFound – item_id is not found Raise:NullArgument – item_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – assessment failure

compliance: mandatory – This method must be implemented.

Item Bank Assignment Methods

Bank.can_assign_items()

Tests if this user can alter item/bank mappings.

A return of true does not guarantee successful assessment. A return of false indicates that it is known mapping methods in this session will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returns:false if mapping is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.can_assign_items_to_bank(bank_id)

Tests if this user can alter item/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 to unauthorized users.

Parameters:bank_id (osid.id.Id) – the Id of the Bank Returns:false if mapping is not authorized, true otherwise Return type:boolean Raise:NullArgument – bank_id is null

compliance: mandatory – This method must be implemented.

Bank.get_assignable_bank_ids(bank_id)

Gets a list of banks including and under the given banks node in which any assessment taken can be assigned.

Parameters:bank_id (osid.id.Id) – the Id of the Bank Returns:list of assignable bank Ids Return type:osid.id.IdList Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.

Bank.get_assignable_bank_ids_for_item(bank_id, item_id)

Gets a list of banks including and under the given bank node in which a specific item can be assigned.

Parameters:

• bank_id (osid.id.Id) – the Id of the Bank
• item_id (osid.id.Id) – the Id of the Item

Returns:

list of assignable bank Ids

Return type:

osid.id.IdList

Raise:

NullArgument – bank_id or item_id is null

Raise:

OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.

Bank.assign_item_to_bank(item_id, bank_id)

Adds an existing Item to a Bank.

Parameters:

• item_id (osid.id.Id) – the Id of the Item
• bank_id (osid.id.Id) – the Id of the Bank

Raise:

AlreadyExists – item_id is already assigned to bank_id

Raise:

NotFound – item_id or bank_id not found

Raise:

NullArgument – item_id or bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.unassign_item_from_bank(item_id, bank_id)

Removes an Item from a Bank.

Parameters:

• item_id (osid.id.Id) – the Id of the Item
• bank_id (osid.id.Id) – the Id of the Bank

Raise:

NotFound – item_id or bank_id not found or item_id not assigned to bank_id

Raise:

NullArgument – item_id or bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.reassign_item_to_billing(item_id, from_bank_id, to_bank_id)

Moves an Item from one Bank to another.

Mappings to other Banks are unaffected.

Parameters:

• item_id (osid.id.Id) – the Id of the Item
• from_bank_id (osid.id.Id) – the Id of the current Bank
• to_bank_id (osid.id.Id) – the Id of the destination Bank

Raise:

NotFound – item_id, from_bank_id, or to_bank_id not found or item_id not mapped to from_bank_id

Raise:

NullArgument – item_id, from_bank_id, or to_bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Assessment Lookup Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_lookup_assessments()

Tests if this user can perform Assessment 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 a PermissionDenied. 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 otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.use_comparative_assessment_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.

compliance: mandatory – This method is must be implemented.

Bank.use_plenary_assessment_view()

A complete view of the Assessment 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.

compliance: mandatory – This method is must be implemented.

Bank.use_federated_bank_view()

Federates the view for methods in this session.

A federated view will include assessments taken in banks which are children of this bank in the bank hierarchy.

compliance: mandatory – This method is must be implemented.

Bank.use_isolated_bank_view()

Isolates the view for methods in this session.

An isolated view restricts searches to this bank only.

compliance: mandatory – This method is must be implemented.

Bank.get_assessment(assessment_id)

Gets the Assessment specified by its Id.

In plenary mode, the exact Id is found or a NotFound results. Otherwise, the returned Assessment may have a different Id than requested, such as the case where a duplicate Id was assigned to a Assessment and retained for compatibility.

Parameters:assessment_id (osid.id.Id) – Id of the Assessment Returns:the assessment Return type:osid.assessment.Assessment Raise:NotFound – assessment_id not found Raise:NullArgument – assessment_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method is must be implemented.

Bank.get_assessments_by_ids(assessment_ids)

Gets an AssessmentList corresponding to the given IdList.

In plenary mode, the returned list contains all of the assessments specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Assessments may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:assessment_ids (osid.id.IdList) – the list of Ids to retrieve Returns:the returned Assessment list Return type:osid.assessment.AssessmentList Raise:NotFound – an Id was not found Raise:NullArgument – assessment_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – assessment failure

compliance: mandatory – This method must be implemented.

Bank.get_assessments_by_genus_type(assessment_genus_type)

Gets an AssessmentList corresponding to the given assessment genus Type which does not include assessments of types derived from the specified Type.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

Parameters:assessment_genus_type (osid.type.Type) – an assessment genus type Returns:the returned Assessment list Return type:osid.assessment.AssessmentList Raise:NullArgument – assessment_genus_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_by_parent_genus_type(assessment_genus_type)

Gets an AssessmentList corresponding to the given assessment genus Type and include any additional assessments with genus types derived from the specified Type.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

Parameters:assessment_genus_type (osid.type.Type) – an assessment genus type Returns:the returned Assessment list Return type:osid.assessment.AssessmentList Raise:NullArgument – assessment_genus_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_by_record_type(assessment_record_type)

Gets an AssessmentList corresponding to the given assessment record Type.

The set of assessments implementing the given record type is returned. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

Parameters:assessment_record_type (osid.type.Type) – an assessment record type Returns:the returned Assessment list Return type:osid.assessment.AssessmentList Raise:NullArgument – assessment_record_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.assessments

Gets all Assessments.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

Returns:a list of Assessments Return type:osid.assessment.AssessmentList Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Assessment Query Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_search_assessments()

Tests if this user can perform Assessment searches.

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 pplication that may wish not to offer search operations to unauthorized users.

Returns:false if search methods are not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.use_federated_bank_view()

Federates the view for methods in this session.

A federated view will include assessments taken in banks which are children of this bank in the bank hierarchy.

compliance: mandatory – This method is must be implemented.

Bank.use_isolated_bank_view()

Isolates the view for methods in this session.

An isolated view restricts searches to this bank only.

compliance: mandatory – This method is must be implemented.

Bank.assessment_query

Gets an assessment query.

Returns:the assessment query Return type:osid.assessment.AssessmentQuery

compliance: mandatory – This method must be implemented.

Bank.get_assessments_by_query(assessment_query)

Gets a list of Assessments matching the given assessment query.

Parameters:assessment_query (osid.assessment.AssessmentQuery) – the assessment query Returns:the returned AssessmentList Return type:osid.assessment.AssessmentList Raise:NullArgument – assessment_query is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – assessment_query is not of this service

compliance: mandatory – This method must be implemented.

Assessment Admin Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_create_assessments()

Tests if this user can create Assessments.

A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Assessment will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:false if Assessment creation is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.can_create_assessment_with_record_types(assessment_record_types)

Tests if this user can create a single Assessment using the desired record interface types.

While AssessmentManager.getAssessmentRecordTypes() can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific Assessment. Providing an empty array tests if an Assessment can be created with no records.

Parameters:assessment_record_types (osid.type.Type[]) – array of assessment record types Returns:true if Assessment creation using the specified record Types is supported, false otherwise Return type:boolean Raise:NullArgument – assessment_record_types is null

compliance: mandatory – This method must be implemented.

Bank.get_assessment_form_for_create(assessment_record_types)

Gets the assessment form for creating new assessments.

A new form should be requested for each create transaction.

Parameters:assessment_record_types (osid.type.Type[]) – array of assessment record types to be included in the create operation or an empty list if none Returns:the assessment form Return type:osid.assessment.AssessmentForm Raise:NullArgument – assessment_record_types is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – unable to get form for requested record types

compliance: mandatory – This method must be implemented.

Bank.create_assessment(assessment_form)

Creates a new Assessment.

Parameters:assessment_form (osid.assessment.AssessmentForm) – the form for this Assessment Returns:the new Assessment Return type:osid.assessment.Assessment Raise:IllegalState – assessment_form already used in a create transaction Raise:InvalidArgument – one or more of the form elements is invalid Raise:NullArgument – assessment_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – assessment_form did not originate from get_assessment_form_for_create()

compliance: mandatory – This method must be implemented.

Bank.can_update_assessments()

Tests if this user can update Assessments.

A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an Assessment will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:false if Assessment modification is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.get_assessment_form_for_update(assessment_id)

Gets the assessment form for updating an existing assessment.

A new assessment form should be requested for each update transaction.

Parameters:assessment_id (osid.id.Id) – the Id of the Assessment Returns:the assessment form Return type:osid.assessment.AssessmentForm Raise:NotFound – assessment_id is not found Raise:NullArgument – assessment_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.update_assessment(assessment_form)

Updates an existing assessment.

Parameters:assessment_form (osid.assessment.AssessmentForm) – the form containing the elements to be updated Raise:IllegalState – assessment_form already used in an update transaction Raise:InvalidArgument – the form contains an invalid value Raise:NullArgument – assessment_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – assessment_form did not originate from get_assessment_form_for_update()

compliance: mandatory – This method must be implemented.

Bank.can_delete_assessments()

Tests if this user can delete Assessments.

A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an Assessment will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:false if Assessment deletion is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.delete_assessment(assessment_id)

Deletes an Assessment.

Parameters:assessment_id (osid.id.Id) – the Id of the Assessment to remove Raise:NotFound – assessment_id not found Raise:NullArgument – assessment_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_manage_assessment_aliases()

Tests if this user can manage Id aliases for Assessments.

A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:false if Assessment aliasing is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.alias_assessment(assessment_id, alias_id)

Adds an Id to an Assessment for the purpose of creating compatibility.

The primary Id of the Assessment is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another assessment, it is reassigned to the given assessment Id.

Parameters:

• assessment_id (osid.id.Id) – the Id of an Assessment
• alias_id (osid.id.Id) – the alias Id

Raise:

AlreadyExists – alias_id is in use as a primary Id

Raise:

NotFound – assessment_id not found

Raise:

NullArgument – assessment_id or alias_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Assessment Bank Methods

Bank.can_lookup_assessment_bank_mappings()

Tests if this user can perform lookups of assessment/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 to unauthorized users.

Returns:false if looking up mappings is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.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.

compliance: mandatory – This method is must be implemented.

Bank.use_plenary_bank_view()

A complete view of the AssessmentTaken and 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.

compliance: mandatory – This method is must be implemented.

Bank.get_assessment_ids_by_bank(bank_id)

Gets the list of Assessment Ids associated with a Bank.

Parameters:bank_id (osid.id.Id) – Id of the Bank Returns:list of related assessment Ids Return type:osid.id.IdList Raise:NotFound – bank_id is not found Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_by_bank(bank_id)

Gets the list of Assessments associated with a Bank.

Parameters:bank_id (osid.id.Id) – Id of the Bank Returns:list of related assessments Return type:osid.assessment.AssessmentList Raise:NotFound – bank_id is not found Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessment_ids_by_banks(bank_ids)

Gets the list of Assessment Ids corresponding to a list of Banks.

Parameters:bank_ids (osid.id.IdList) – list of bank Ids Returns:list of bank Ids Return type:osid.id.IdList Raise:NullArgument – bank_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_by_banks(bank_ids)

Gets the list of Assessments corresponding to a list of Banks.

Parameters:bank_ids (osid.id.IdList) – list of bank Ids Returns:list of assessments Return type:osid.assessment.AssessmentList Raise:NullArgument – bank_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_bank_ids_by_assessment(assessment_id)

Gets the list of Bank Ids mapped to an Assessment.

Parameters:assessment_id (osid.id.Id) – Id of an Assessment Returns:list of bank Ids Return type:osid.id.IdList Raise:NotFound – assessment_id is not found Raise:NullArgument – assessment_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_banks_by_assessment(assessment_id)

Gets the list of Banks mapped to an Assessment.

Parameters:assessment_id (osid.id.Id) – Id of an Assessment Returns:list of banks Return type:osid.assessment.BankList Raise:NotFound – assessment_id is not found Raise:NullArgument – assessment_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Assessment Bank Assignment Methods

Bank.can_assign_assessments()

Tests if this user can alter assessment/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 to unauthorized users.

Returns:false if mapping is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.can_assign_assessments_to_bank(bank_id)

Tests if this user can alter assessment/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 to unauthorized users.

Parameters:bank_id (osid.id.Id) – the Id of the Bank Returns:false if mapping is not authorized, true otherwise Return type:boolean Raise:NullArgument – bank_id is null

compliance: mandatory – This method must be implemented.

Bank.get_assignable_bank_ids(bank_id)

Gets a list of banks including and under the given banks node in which any assessment taken can be assigned.

Parameters:bank_id (osid.id.Id) – the Id of the Bank Returns:list of assignable bank Ids Return type:osid.id.IdList Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.

Bank.get_assignable_bank_ids_for_assessment(bank_id, assessment_id)

Gets a list of bank including and under the given bank node in which a specific assessment can be assigned.

Parameters:

• bank_id (osid.id.Id) – the Id of the Bank
• assessment_id (osid.id.Id) – the Id of the Assessment

Returns:

list of assignable bank Ids

Return type:

osid.id.IdList

Raise:

NullArgument – bank_id or assessment_id is null

Raise:

OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.

Bank.assign_assessment_to_bank(assessment_id, bank_id)

Adds an existing Assessment to a Bank.

Parameters:

• assessment_id (osid.id.Id) – the Id of the Assessment
• bank_id (osid.id.Id) – the Id of the Bank

Raise:

AlreadyExists – assessment_id is already assigned to bank_id

Raise:

NotFound – assessment_id or bank_id not found

Raise:

NullArgument – assessment_id or bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.unassign_assessment_from_bank(assessment_id, bank_id)

Removes an Assessment from a Bank.

Parameters:

• assessment_id (osid.id.Id) – the Id of the Assessment
• bank_id (osid.id.Id) – the Id of the Bank

Raise:

NotFound – assessment_id or bank_id not found or assessment_id not assigned to bank_id

Raise:

NullArgument – assessment_id or bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.reassign_assessment_to_billing(assessment_id, from_bank_id, to_bank_id)

Moves an Assessment from one Bank to another.

Mappings to other Banks are unaffected.

Parameters:

• assessment_id (osid.id.Id) – the Id of the Assessment
• from_bank_id (osid.id.Id) – the Id of the current Bank
• to_bank_id (osid.id.Id) – the Id of the destination Bank

Raise:

NotFound – assessment_id, from_bank_id, or to_bank_id not found or assessment_id not mapped to from_bank_id

Raise:

NullArgument – assessment_id, from_bank_id, or to_bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Assessment Basic Authoring Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_author_assessments()

Tests if this user can author assessments.

A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer authoring operations to unauthorized users.

Returns:false if mapping is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.get_items()

Gets all Items.

In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.

Returns:a list of Items Return type:osid.assessment.ItemList Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.add_item(assessment_id, item_id)

Adds an existing Item to an assessment.

Parameters:

• assessment_id (osid.id.Id) – the Id of the Assessment
• item_id (osid.id.Id) – the Id of the Item

Raise:

NotFound – assessment_id or item_id not found

Raise:

NullArgument – assessment_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.remove_item(assessment_id, item_id)

Removes an Item from this assessment.

Parameters:

• assessment_id (osid.id.Id) – the Id of the Assessment
• item_id (osid.id.Id) – the Id of the Item

Raise:

NotFound – assessment_id or item_id not found or item_id not on assessmentid

Raise:

NullArgument – assessment_id or item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.move_item(assessment_id, item_id, preceeding_item_id)

Moves an existing item to follow another item in an assessment.

Parameters:

• assessment_id (osid.id.Id) – the Id of the Assessment
• item_id (osid.id.Id) – the Id of an Item
• preceeding_item_id (osid.id.Id) – the Id of a preceeding Item in the sequence

Raise:

NotFound – assessment_id is not found, or item_id or preceeding_item_id not on assessment_id

Raise:

NullArgument – assessment_id, item_id or preceeding_item_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.order_items(item_ids, assessment_id)

Sequences existing items in an assessment.

Parameters:

• item_ids (osid.id.Id[]) – the Id of the Items
• assessment_id (osid.id.Id) – the Id of the Assessment

Raise:

NotFound – assessment_id is not found or an item_id is not on assessment_id

Raise:

NullArgument – assessment_id or item_ids is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Assessment Offered Lookup Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_lookup_assessments_offered()

Tests if this user can perform AssessmentOffered 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 a PermissionDenied. 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 otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.use_comparative_assessment_offered_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.

compliance: mandatory – This method is must be implemented.

Bank.use_plenary_assessment_offered_view()

A complete view of the AssessmentOffered 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.

compliance: mandatory – This method is must be implemented.

Bank.use_federated_bank_view()

Federates the view for methods in this session.

A federated view will include assessments taken in banks which are children of this bank in the bank hierarchy.

compliance: mandatory – This method is must be implemented.

Bank.use_isolated_bank_view()

Isolates the view for methods in this session.

An isolated view restricts searches to this bank only.

compliance: mandatory – This method is must be implemented.

Bank.get_assessment_offered(assessment_offered_id)

Gets the AssessmentOffered specified by its Id.

In plenary mode, the exact Id is found or a NotFound results. Otherwise, the returned AssessmentOffered may have a different Id than requested, such as the case where a duplicate Id was assigned to an AssessmentOffered and retained for compatibility.

Parameters:assessment_offered_id (osid.id.Id) – Id of the AssessmentOffered Returns:the assessment offered Return type:osid.assessment.AssessmentOffered Raise:NotFound – assessment_offered_id not found Raise:NullArgument – assessment_offered_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method is must be implemented.

Bank.get_assessments_offered_by_ids(assessment_offered_ids)

Gets an AssessmentOfferedList corresponding to the given IdList.

In plenary mode, the returned list contains all of the assessments specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AssessmentOffered objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:assessment_offered_ids (osid.id.IdList) – the list of Ids to retrieve Returns:the returned AssessmentOffered list Return type:osid.assessment.AssessmentOfferedList Raise:NotFound – an Id was not found Raise:NullArgument – assessment_offered_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – assessment failure

compliance: mandatory – This method must be implemented.

Bank.get_assessments_offered_by_genus_type(assessment_offered_genus_type)

Gets an AssessmentOfferedList corresponding to the given assessment offered genus Type which does not include assessments of types derived from the specified Type.

In plenary mode, the returned list contains all known assessments offered or an error results. Otherwise, the returned list may contain only those assessments offered that are accessible through this session.

Parameters:assessment_offered_genus_type (osid.type.Type) – an assessment offered genus type Returns:the returned AssessmentOffered list Return type:osid.assessment.AssessmentOfferedList Raise:NullArgument – assessment_offered_genus_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_offered_by_parent_genus_type(assessment_offered_genus_type)

Gets an AssessmentOfferedList corresponding to the given assessment offered genus Type and include any additional assessments with genus types derived from the specified Type.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments offered that are accessible through this session.

Parameters:assessment_offered_genus_type (osid.type.Type) – an assessment offered genus type Returns:the returned AssessmentOffered list Return type:osid.assessment.AssessmentOfferedList Raise:NullArgument – assessment_offered_genus_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_offered_by_record_type(assessment_record_type)

Gets an AssessmentOfferedList corresponding to the given assessment offered record Type.

The set of assessments implementing the given record type is returned. In plenary mode, the returned list contains all known assessments offered or an error results. Otherwise, the returned list may contain only those assessments offered that are accessible through this session.

Parameters:assessment_record_type (osid.type.Type) – an assessment offered record type Returns:the returned AssessmentOffered list Return type:osid.assessment.AssessmentOfferedList Raise:NullArgument – assessment_offered_record_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_offered_by_date(start, end)

Gets an AssessmentOfferedList that have designated start times where the start times fall in the given range inclusive.

In plenary mode, the returned list contains all known assessments offered or an error results. Otherwise, the returned list may contain only those assessments offered that are accessible through this session.

Parameters:

• start (osid.calendaring.DateTime) – start of time range
• end (osid.calendaring.DateTime) – end of time range

Returns:

the returned AssessmentOffered list

Return type:

osid.assessment.AssessmentOfferedList

Raise:

InvalidArgument – end is less than start

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_offered_for_assessment(assessment_id)

Gets an AssessmentOfferedList by the given assessment.

In plenary mode, the returned list contains all known assessments offered or an error results. Otherwise, the returned list may contain only those assessments offered that are accessible through this session.

Parameters:assessment_id (osid.id.Id) – Id of an Assessment Returns:the returned AssessmentOffered list Return type:osid.assessment.AssessmentOfferedList Raise:NullArgument – assessment_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.assessments_offered

Gets all AssessmentOffered elements.

In plenary mode, the returned list contains all known assessments offered or an error results. Otherwise, the returned list may contain only those assessments offered that are accessible through this session.

Returns:a list of AssessmentOffered elements Return type:osid.assessment.AssessmentOfferedList Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Assessment Offered Query Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_search_assessments_offered()

Tests if this user can perform AssessmentOffered searches.

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 wish not to offer search operations to unauthorized users.

Returns:false if search methods are not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.use_federated_bank_view()

Federates the view for methods in this session.

A federated view will include assessments taken in banks which are children of this bank in the bank hierarchy.

compliance: mandatory – This method is must be implemented.

Bank.use_isolated_bank_view()

Isolates the view for methods in this session.

An isolated view restricts searches to this bank only.

compliance: mandatory – This method is must be implemented.

Bank.assessment_offered_query

Gets an assessment offered query.

Returns:the assessment offered query Return type:osid.assessment.AssessmentOfferedQuery

compliance: mandatory – This method must be implemented.

Bank.get_assessments_offered_by_query(assessment_offered_query)

Gets a list of AssessmentOffered elements matching the given assessment offered query.

Parameters:assessment_offered_query (osid.assessment.AssessmentOfferedQuery) – the assessment offered query Returns:the returned AssessmentOfferedList Return type:osid.assessment.AssessmentOfferedList Raise:NullArgument – assessment_offered_query is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – assessment_offered_query is not of this service

compliance: mandatory – This method must be implemented.

Assessment Offered Admin Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_create_assessments_offered()

Tests if this user can create AssessmentOffered objects.

A return of true does not guarantee successful authoriization. A return of false indicates that it is known creating an AssessmentOffered will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:false if AssessmentOffered creation is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.can_create_assessment_offered_with_record_types(assessment_offered_record_types)

Tests if this user can create a single AssessmentOffered using the desired record types.

While AssessmentManager.getAssessmentOfferedRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific AssessmentOffered. Providing an empty array tests if an AssessmentOffered can be created with no records.

Parameters:assessment_offered_record_types (osid.type.Type[]) – array of assessment offered record types Returns:true if AssessmentOffered creation using the specified record Types is supported, false otherwise Return type:boolean Raise:NullArgument – assessment_offered_record_types is null

compliance: mandatory – This method must be implemented.

Bank.get_assessment_offered_form_for_create(assessment_id, assessment_offered_record_types)

Gets the assessment offered form for creating new assessments offered.

A new form should be requested for each create transaction.

Parameters:

• assessment_id (osid.id.Id) – the Id of the related Assessment
• assessment_offered_record_types (osid.type.Type[]) – array of assessment offered record types to be included in the create operation or an empty list if none

Returns:

the assessment offered form

Return type:

osid.assessment.AssessmentOfferedForm

Raise:

NotFound – assessment_id is not found

Raise:

NullArgument – assessment_id or assessment_offered_record_types is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

Raise:

Unsupported – unable to get form for requested record types

compliance: mandatory – This method must be implemented.

Bank.create_assessment_offered(assessment_offered_form)

Creates a new AssessmentOffered.

Parameters:assessment_offered_form (osid.assessment.AssessmentOfferedForm) – the form for this AssessmentOffered Returns:the new AssessmentOffered Return type:osid.assessment.AssessmentOffered Raise:IllegalState – assessment_offrered_form already used in a create transaction Raise:InvalidArgument – one or more of the form elements is invalid Raise:NullArgument – assessment_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – assessment_form did not originate from get_assessment_form_for_create()

compliance: mandatory – This method must be implemented.

Bank.can_update_assessments_offered()

Tests if this user can update AssessmentOffered objects.

A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AssessmentOffered will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:false if Assessment modification is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.get_assessment_offered_form_for_update(assessment_offered_id)

Gets the assessment offered form for updating an existing assessment offered.

A new assessment offered form should be requested for each update transaction.

Parameters:assessment_offered_id (osid.id.Id) – the Id of the AssessmentOffered Returns:the assessment offered form Return type:osid.assessment.AssessmentOfferedForm Raise:NotFound – assessment_offered_id is not found Raise:NullArgument – assessment_offered_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.update_assessment_offered(assessment_offered_form)

Updates an existing assessment offered.

Parameters:assessment_offered_form (osid.assessment.AssessmentOfferedForm) – the form containing the elements to be updated Raise:IllegalState – assessment_offrered_form already used in an update transaction Raise:InvalidArgument – the form contains an invalid value Raise:NullArgument – assessment_offered_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – assessment_form did not originate from get_assessment_form_for_update()

compliance: mandatory – This method must be implemented.

Bank.can_delete_assessments_offered()

Tests if this user can delete AssessmentsOffered.

A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AssessmentOffered will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer a delete operations to unauthorized users.

Returns:false if AssessmentOffered deletion is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.delete_assessment_offered(assessment_offered_id)

Deletes an AssessmentOffered.

Parameters:assessment_offered_id (osid.id.Id) – the Id of the AssessmentOffered to remove Raise:NotFound – assessment_offered_id not found Raise:NullArgument – assessment_offered_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_manage_assessment_offered_aliases()

Tests if this user can manage Id aliases for AssessmentsOffered.

A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:false if AssessmentOffered aliasing is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.alias_assessment_offered(assessment_offered_id, alias_id)

Adds an Id to an AssessmentOffered for the purpose of creating compatibility.

The primary Id of the AssessmentOffered is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another assessment offered, it is reassigned to the given assessment offered Id.

Parameters:

• assessment_offered_id (osid.id.Id) – the Id of an AssessmentOffered
• alias_id (osid.id.Id) – the alias Id

Raise:

AlreadyExists – alias_id is in use as a primary Id

Raise:

NotFound – assessment_offered_id not found

Raise:

NullArgument – assessment_offered_id or alias_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Assessment Offered Bank Methods

Bank.can_lookup_assessment_offered_bank_mappings()

Tests if this user can perform lookups of assessment offered/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 to unauthorized users.

Returns:false if looking up mappings is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.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.

compliance: mandatory – This method is must be implemented.

Bank.use_plenary_bank_view()

A complete view of the AssessmentTaken and 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.

compliance: mandatory – This method is must be implemented.

Bank.get_assessment_offered_ids_by_bank(bank_id)

Gets the list of AssessmentOffered Ids associated with a Bank.

Parameters:bank_id (osid.id.Id) – Id of the Bank Returns:list of related assessment offered Ids Return type:osid.id.IdList Raise:NotFound – bank_id is not found Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_offered_by_bank(bank_id)

Gets the list of AssessmentOffereds associated with a Bank.

Parameters:bank_id (osid.id.Id) – Id of the Bank Returns:list of related assessments offered Return type:osid.assessment.AssessmentOfferedList Raise:NotFound – bank_id is not found Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessment_offered_ids_by_banks(bank_ids)

Gets the list of AssessmentOffered Ids corresponding to a list of Banks.

Parameters:bank_ids (osid.id.IdList) – list of bank Ids Returns:list of bank Ids Return type:osid.id.IdList Raise:NullArgument – bank_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_offered_by_banks(bank_ids)

Gets the list of AssessmentOffered objects corresponding to a list of Banks.

Parameters:bank_ids (osid.id.IdList) – list of bank Ids Returns:list of assessments offered Return type:osid.assessment.AssessmentOfferedList Raise:NullArgument – bank_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_bank_ids_by_assessment_offered(assessment_offered_id)

Gets the list of Bank Ids mapped to an AssessmentOffered.

Parameters:assessment_offered_id (osid.id.Id) – Id of an AssessmentOffered Returns:list of bank Ids Return type:osid.id.IdList Raise:NotFound – assessment_offered_id is not found Raise:NullArgument – assessment_offered_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_banks_by_assessment_offered(assessment_offered_id)

Gets the list of Banks mapped to an AssessmentOffered.

Parameters:assessment_offered_id (osid.id.Id) – Id of an AssessmentOffered Returns:list of banks Return type:osid.assessment.BankList Raise:NotFound – assessment_offered_id is not found Raise:NullArgument – assessment_offered_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Assessment Offered Bank Assignment Methods

Bank.can_assign_assessments_offered()

Tests if this user can alter assessment offered/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 to unauthorized users.

Returns:false if mapping is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.can_assign_assessments_offered_to_bank(bank_id)

Tests if this user can alter assessment offered/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 to unauthorized users.

Parameters:bank_id (osid.id.Id) – the Id of the Bank Returns:false if mapping is not authorized, true otherwise Return type:boolean Raise:NullArgument – bank_id is null

compliance: mandatory – This method must be implemented.

Bank.get_assignable_bank_ids(bank_id)

Gets a list of banks including and under the given banks node in which any assessment taken can be assigned.

Parameters:bank_id (osid.id.Id) – the Id of the Bank Returns:list of assignable bank Ids Return type:osid.id.IdList Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.

Bank.get_assignable_bank_ids_for_assessment_offered(bank_id, assessment_offered_id)

Gets a list of bank including and under the given bank node in which a specific assessment offered can be assigned.

Parameters:

• bank_id (osid.id.Id) – the Id of the Bank
• assessment_offered_id (osid.id.Id) – the Id of the AssessmentOffered

Returns:

list of assignable bank Ids

Return type:

osid.id.IdList

Raise:

NullArgument – bank_id or assessment_offered_id is null

Raise:

OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.

Bank.assign_assessment_offered_to_bank(assessment_offered_id, bank_id)

Adds an existing AssessmentOffered to a Bank.

Parameters:

• assessment_offered_id (osid.id.Id) – the Id of the AssessmentOffered
• bank_id (osid.id.Id) – the Id of the Bank

Raise:

AlreadyExists – assessment_offered_id is already assigned to bank_id

Raise:

NotFound – assessment_offered_id or bank_id not found

Raise:

NullArgument – assessment_offered_id or bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.unassign_assessment_offered_from_bank(assessment_offered_id, bank_id)

Removes an AssessmentOffered from a Bank.

Parameters:

• assessment_offered_id (osid.id.Id) – the Id of the AssessmentOffered
• bank_id (osid.id.Id) – the Id of the Bank

Raise:

NotFound – assessment_offered_id or bank_id not found or assessment_offered_id not assigned to bank_id

Raise:

NullArgument – assessment_offered_id or bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.reassign_assessment_offered_to_billing(assessment_offered_id, from_bank_id, to_bank_id)

Moves an AssessmentOffered from one Bank to another.

Mappings to other Banks are unaffected.

Parameters:

• assessment_offered_id (osid.id.Id) – the Id of the AssessmentOffered
• from_bank_id (osid.id.Id) – the Id of the current Bank
• to_bank_id (osid.id.Id) – the Id of the destination Bank

Raise:

NotFound – assessment_offered_id, from_bank_id, or to_bank_id not found or assessment_offered_id not mapped to from_bank_id

Raise:

NullArgument – assessment_offered_id, from_bank_id, or to_bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.

Assessment Taken Lookup Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_lookup_assessments_taken()

Tests if this user can perform AssessmentTaken 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 a PermissionDenied. 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 otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.use_comparative_assessment_taken_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.

compliance: mandatory – This method is must be implemented.

Bank.use_plenary_assessment_taken_view()

A complete view of the AssessmentTaken 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.

compliance: mandatory – This method is must be implemented.

Bank.use_federated_bank_view()

Federates the view for methods in this session.

A federated view will include assessments taken in banks which are children of this bank in the bank hierarchy.

compliance: mandatory – This method is must be implemented.

Bank.use_isolated_bank_view()

Isolates the view for methods in this session.

An isolated view restricts searches to this bank only.

compliance: mandatory – This method is must be implemented.

Bank.get_assessment_taken(assessment_taken_id)

Gets the AssessmentTaken specified by its Id.

In plenary mode, the exact Id is found or a NotFound results. Otherwise, the returned AssessmentTaken may have a different Id than requested, such as the case where a duplicate Id was assigned to an AssessmentTaken and retained for compatibility.

Parameters:assessment_taken_id (osid.id.Id) – Id of the AssessmentTaken Returns:the assessment taken Return type:osid.assessment.AssessmentTaken Raise:NotFound – assessment_taken_id not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method is must be implemented.

Bank.get_assessments_taken_by_ids(assessment_taken_ids)

Gets an AssessmentTakenList corresponding to the given IdList.

In plenary mode, the returned list contains all of the assessments specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AssessmentTaken objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:assessment_taken_ids (osid.id.IdList) – the list of Ids to retrieve Returns:the returned AssessmentTaken list Return type:osid.assessment.AssessmentTakenList Raise:NotFound – an Id was not found Raise:NullArgument – assessment_taken_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – assessment failure

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_genus_type(assessment_taken_genus_type)

Gets an AssessmentTakenList corresponding to the given assessment taken genus Type which does not include assessments of types derived from the specified Type.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:assessment_taken_genus_type (osid.type.Type) – an assessment taken genus type Returns:the returned AssessmentTaken list Return type:osid.assessment.AssessmentTakenList Raise:NullArgument – assessment_taken_genus_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_parent_genus_type(assessment_taken_genus_type)

Gets an AssessmentTakenList corresponding to the given assessment taken genus Type and include any additional assessments with genus types derived from the specified Type.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:assessment_taken_genus_type (osid.type.Type) – an assessment taken genus type Returns:the returned AssessmentTaken list Return type:osid.assessment.AssessmentTakenList Raise:NullArgument – assessment_taken_genus_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_record_type(assessment_taken_record_type)

Gets an AssessmentTakenList corresponding to the given assessment taken record Type.

The set of assessments implementing the given record type is returned. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session. In both cases, the order of the set is not specified.

Parameters:assessment_taken_record_type (osid.type.Type) – an assessment taken record type Returns:the returned AssessmentTaken list Return type:osid.assessment.AssessmentTakenList Raise:NullArgument – assessment_taken_record_type is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_date(from_, to)

Gets an AssessmentTakenList started in the given date range inclusive.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session. In both cases, the order of the set is not specified.

Parameters:

• from (osid.calendaring.DateTime) – start date
• to (osid.calendaring.DateTime) – end date

Returns:

the returned AssessmentTaken list

Return type:

osid.assessment.AssessmentTakenList

Raise:

InvalidArgument – from is greater than to

Raise:

NullArgument – from or to is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_for_taker(resource_id)

Gets an AssessmentTakenList for the given resource.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:resource_id (osid.id.Id) – Id of a Resource Returns:the returned AssessmentTaken list Return type:osid.assessment.AssessmentTakenList Raise:NullArgument – resource_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_date_for_taker(resource_id, from_, to)

Gets an AssessmentTakenList started in the given date range inclusive for the given resource.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:

• resource_id (osid.id.Id) – Id of a Resource
• from (osid.calendaring.DateTime) – start date
• to (osid.calendaring.DateTime) – end date

Returns:

the returned AssessmentTaken list

Return type:

osid.assessment.AssessmentTakenList

Raise:

InvalidArgument – from is greater than to

Raise:

NullArgument – resource_id, from or to is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_for_assessment(assessment_id)

Gets an AssessmentTakenList for the given assessment.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:assessment_id (osid.id.Id) – Id of an Assessment Returns:the returned AssessmentTaken list Return type:osid.assessment.AssessmentTakenList Raise:NullArgument – assessment_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_date_for_assessment(assessment_id, from_, to)

Gets an AssessmentTakenList started in the given date range inclusive for the given assessment.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:

• assessment_id (osid.id.Id) – Id of an Assessment
• from (osid.calendaring.DateTime) – start date
• to (osid.calendaring.DateTime) – end date

Returns:

the returned AssessmentTaken list

Return type:

osid.assessment.AssessmentTakenList

Raise:

InvalidArgument – from is greater than to

Raise:

NullArgument – assessment_id, from or to is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_for_taker_and_assessment(resource_id, assessment_id)

Gets an AssessmentTakenList for the given resource and assessment.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:

• resource_id (osid.id.Id) – Id of a Resource
• assessment_id (osid.id.Id) – Id of an Assessment

Returns:

the returned AssessmentTaken list

Return type:

osid.assessment.AssessmentTakenList

Raise:

NullArgument – resource_id or assessment_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_date_for_taker_and_assessment(resource_id, assessment_id, from_, to)

Gets an AssessmentTakenList started in the given date range inclusive for the given resource and assessment.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:

• resource_id (osid.id.Id) – Id of a Resource
• assessment_id (osid.id.Id) – Id of an Assessment
• from (osid.calendaring.DateTime) – start date
• to (osid.calendaring.DateTime) – end date

Returns:

the returned AssessmentTaken list

Return type:

osid.assessment.AssessmentTakenList

Raise:

InvalidArgument – from is greater than to

Raise:

NullArgument – resource_id, assessment_id, from or to is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_for_assessment_offered(assessment_offered_id)

Gets an AssessmentTakenList by the given assessment offered.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:assessment_offered_id (osid.id.Id) – Id of an AssessmentOffered Returns:the returned AssessmentTaken list Return type:osid.assessment.AssessmentTakenList Raise:NullArgument – assessment_offered_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_date_for_assessment_offered(assessment_offered_id, from_, to)

Gets an AssessmentTakenList started in the given date range inclusive for the given assessment offered.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:

• assessment_offered_id (osid.id.Id) – Id of an AssessmentOffered
• from (osid.calendaring.DateTime) – start date
• to (osid.calendaring.DateTime) – end date

Returns:

the returned AssessmentTaken list

Return type:

osid.assessment.AssessmentTakenList

Raise:

InvalidArgument – from is greater than to

Raise:

NullArgument – assessment_offered_id, from, or to is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_for_taker_and_assessment_offered(resource_id, assessment_offered_id)

Gets an AssessmentTakenList for the given resource and assessment offered.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:

• resource_id (osid.id.Id) – Id of a Resource
• assessment_offered_id (osid.id.Id) – Id of an AssessmentOffered

Returns:

the returned AssessmentTaken list

Return type:

osid.assessment.AssessmentTakenList

Raise:

NullArgument – resource_id or assessmen_offeredt_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_date_for_taker_and_assessment_offered(resource_id, assessment_offered_id, from_, to)

Gets an AssessmentTakenList started in the given date range inclusive for the given resource and assessment offered.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Parameters:

• resource_id (osid.id.Id) – Id of a Resource
• assessment_offered_id (osid.id.Id) – Id of an AssessmentOffered
• from (osid.calendaring.DateTime) – start date
• to (osid.calendaring.DateTime) – end date

Returns:

the returned AssessmentTaken list

Return type:

osid.assessment.AssessmentTakenList

Raise:

InvalidArgument – from is greater than to

Raise:

NullArgument – resource_id, assessment_offered_id, from, or to is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.assessments_taken

Gets all AssessmentTaken elements.

In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.

Returns:a list of AssessmentTaken elements Return type:osid.assessment.AssessmentTakenList Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Assessment Taken Query Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_search_assessments_taken()

Tests if this user can perform AssessmentTaken searches.

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 search operations to unauthorized users.

Returns:false if search methods are not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.use_federated_bank_view()

Federates the view for methods in this session.

A federated view will include assessments taken in banks which are children of this bank in the bank hierarchy.

compliance: mandatory – This method is must be implemented.

Bank.use_isolated_bank_view()

Isolates the view for methods in this session.

An isolated view restricts searches to this bank only.

compliance: mandatory – This method is must be implemented.

Bank.assessment_taken_query

Gets an assessment taken query.

Returns:the assessment taken query Return type:osid.assessment.AssessmentTakenQuery

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_query(assessment_taken_query)

Gets a list of AssessmentTaken elements matching the given assessment taken query.

Parameters:assessment_taken_query (osid.assessment.AssessmentTakenQuery) – the assessment taken query Returns:the returned AssessmentTakenList Return type:osid.assessment.AssessmentTakenList Raise:NullArgument – assessment_taken_query is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – assessment_taken_query is not of this service

compliance: mandatory – This method must be implemented.

Assessment Taken Admin Methods

Bank.bank_id

Gets the Bank Id associated with this session.

Returns:the Bank Id associated with this session Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

Bank.bank

Gets the Bank associated with this session.

Returns:the Bank associated with this session Return type:osid.assessment.Bank Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_create_assessments_taken()

Tests if this user can create AssessmentTaken objects.

A return of true does not guarantee successful authoriization. A return of false indicates that it is known creating an AssessmentTaken will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:false if AssessmentTaken creation is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.can_create_assessment_taken_with_record_types(assessment_taken_record_types)

Tests if this user can create a single AssessmentTaken using the desired record types.

While AssessmentManager.getAssessmentTakenRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific AssessmentTaken. Providing an empty array tests if an AssessmentTaken can be created with no records.

Parameters:assessment_taken_record_types (osid.type.Type[]) – array of assessment taken record types Returns:true if AssessmentTaken creation using the specified record Types is supported, false otherwise Return type:boolean Raise:NullArgument – assessment_taken_record_types is null

compliance: mandatory – This method must be implemented.

Bank.get_assessment_taken_form_for_create(assessment_offered_id, assessment_taken_record_types)

Gets the assessment taken form for creating new assessments taken.

A new form should be requested for each create transaction.

Parameters:

• assessment_offered_id (osid.id.Id) – the Id of the related AssessmentOffered
• assessment_taken_record_types (osid.type.Type[]) – array of assessment taken record types to be included in the create operation or an empty list if none

Returns:

the assessment taken form

Return type:

osid.assessment.AssessmentTakenForm

Raise:

NotFound – assessment_offered_id is not found

Raise:

NullArgument – assessment_offered_id or assessment_taken_record_types is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

Raise:

Unsupported – unable to get form for requested record types

compliance: mandatory – This method must be implemented.

Bank.create_assessment_taken(assessment_taken_form)

Creates a new AssessmentTaken.

Parameters:assessment_taken_form (osid.assessment.AssessmentTakenForm) – the form for this AssessmentTaken Returns:the new AssessmentTaken Return type:osid.assessment.AssessmentTaken Raise:IllegalState – assessment_taken_form already used in a create transaction Raise:InvalidArgument – one or more of the form elements is invalid Raise:NullArgument – assessment_taken_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – assessment_offered_form did not originate from get_assessment_taken_form_for_create()

compliance: mandatory – This method must be implemented.

Bank.can_update_assessments_taken()

Tests if this user can update AssessmentTaken objects.

A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AssessmentTaken will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:false if AssessmentTaken modification is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.get_assessment_taken_form_for_update(assessment_taken_id)

Gets the assessment taken form for updating an existing assessment taken.

A new assessment taken form should be requested for each update transaction.

Parameters:assessment_taken_id (osid.id.Id) – the Id of the AssessmentTaken Returns:the assessment taken form Return type:osid.assessment.AssessmentTakenForm Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.update_assessment_taken(assessment_taken_form)

Updates an existing assessment taken.

Parameters:assessment_taken_form (osid.assessment.AssessmentTakenForm) – the form containing the elements to be updated Raise:IllegalState – assessment_taken_form already used in an update transaction Raise:InvalidArgument – the form contains an invalid value Raise:NullArgument – assessment_taken_form is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred Raise:Unsupported – assessment_offered_form did not originate from get_assessment_taken_form_for_update()

compliance: mandatory – This method must be implemented.

Bank.can_delete_assessments_taken()

Tests if this user can delete AssessmentsTaken.

A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AssessmentTaken will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer a delete operations to unauthorized users.

Returns:false if AssessmentTaken deletion is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.delete_assessment_taken(assessment_taken_id)

Deletes an AssessmentTaken.

Parameters:assessment_taken_id (osid.id.Id) – the Id of the AssessmentTaken to remove Raise:NotFound – assessment_taken_id not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.can_manage_assessment_taken_aliases()

Tests if this user can manage Id aliases for AssessmentsTaken.

A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PermissionDenied. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:false if AssessmentTaken aliasing is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.alias_assessment_taken(assessment_taken_id, alias_id)

Adds an Id to an AssessmentTaken for the purpose of creating compatibility.

The primary Id of the AssessmentTaken is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another assessment taken, it is reassigned to the given assessment taken Id.

Parameters:

• assessment_taken_id (osid.id.Id) – the Id of an AssessmentTaken
• alias_id (osid.id.Id) – the alias Id

Raise:

AlreadyExists – alias_id is in use as a primary Id

Raise:

NotFound – assessment_taken_id not found

Raise:

NullArgument – assessment_taken_id or alias_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Assessment Taken Bank Methods

Bank.can_lookup_assessment_taken_bank_mappings()

Tests if this user can perform lookups of assessment taken/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 to unauthorized users.

Returns:false if looking up mappings is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.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.

compliance: mandatory – This method is must be implemented.

Bank.use_plenary_bank_view()

A complete view of the AssessmentTaken and 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.

compliance: mandatory – This method is must be implemented.

Bank.get_assessment_taken_ids_by_bank(bank_id)

Gets the list of AssessmentTaken Ids associated with a Bank.

Parameters:bank_id (osid.id.Id) – Id of the Bank Returns:list of related assessment taken Ids Return type:osid.id.IdList Raise:NotFound – bank_id is not found Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_bank(bank_id)

Gets the list of AssessmentTakens associated with a Bank.

Parameters:bank_id (osid.id.Id) – Id of the Bank Returns:list of related assessments taken Return type:osid.assessment.AssessmentTakenList Raise:NotFound – bank_id is not found Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessment_taken_ids_by_banks(bank_ids)

Gets the list of AssessmentTaken Ids corresponding to a list of Banks.

Parameters:bank_ids (osid.id.IdList) – list of bank Ids Returns:list of bank Ids Return type:osid.id.IdList Raise:NullArgument – bank_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_assessments_taken_by_banks(bank_ids)

Gets the list of AssessmentTaken objects corresponding to a list of Banks.

Parameters:bank_ids (osid.id.IdList) – list of bank Ids Returns:list of assessments taken Return type:osid.assessment.AssessmentTakenList Raise:NullArgument – bank_ids is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_bank_ids_by_assessment_taken(assessment_taken_id)

Gets the list of Bank Ids mapped to an AssessmentTaken.

Parameters:assessment_taken_id (osid.id.Id) – Id of an AssessmentTaken Returns:list of bank Ids Return type:osid.id.IdList Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.get_banks_by_assessment_taken(assessment_taken_id)

Gets the list of Banks mapped to an AssessmentTaken.

Parameters:assessment_taken_id (osid.id.Id) – Id of an AssessmentTaken Returns:list of banks Return type:osid.assessment.BankList Raise:NotFound – assessment_taken_id is not found Raise:NullArgument – assessment_taken_id is null Raise:OperationFailed – unable to complete request Raise:PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Assessment Taken Bank Assignment Methods

Bank.can_assign_assessments_taken()

Tests if this user can alter assessment taken/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 to unauthorized users.

Returns:false if mapping is not authorized, true otherwise Return type:boolean

compliance: mandatory – This method must be implemented.

Bank.can_assign_assessments_taken_to_bank(bank_id)

Tests if this user can alter assessment taken/bank mappings.

A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 to unauthorized users.

Parameters:bank_id (osid.id.Id) – the Id of the Bank Returns:false if mapping is not authorized, true otherwise Return type:boolean Raise:NullArgument – bank_id is null

compliance: mandatory – This method must be implemented.

Bank.get_assignable_bank_ids(bank_id)

Gets a list of banks including and under the given banks node in which any assessment taken can be assigned.

Parameters:bank_id (osid.id.Id) – the Id of the Bank Returns:list of assignable bank Ids Return type:osid.id.IdList Raise:NullArgument – bank_id is null Raise:OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.

Bank.get_assignable_bank_ids_for_assessment_taken(bank_id, assessment_taken_id)

Gets a list of bank including and under the given bank node in which a specific assessment taken can be assigned.

Parameters:

• bank_id (osid.id.Id) – the Id of the Bank
• assessment_taken_id (osid.id.Id) – the Id of the AssessmentTaken

Returns:

list of assignable bank Ids

Return type:

osid.id.IdList

Raise:

NullArgument – bank_id or assessment_taken_id is null

Raise:

OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.

Bank.assign_assessment_taken_to_bank(assessment_taken_id, bank_id)

Adds an existing AssessmentTaken to a Bank.

Parameters:

• assessment_taken_id (osid.id.Id) – the Id of the AssessmentTaken
• bank_id (osid.id.Id) – the Id of the Bank

Raise:

AlreadyExists – assessment_taken_id is already assigned to bank_id

Raise:

NotFound – assessment_taken_id or bank_id not found

Raise:

NullArgument – assessment_taken_id or bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.unassign_assessment_taken_from_bank(assessment_taken_id, bank_id)

Removes an AssessmentTaken from a Bank.

Parameters:

• assessment_taken_id (osid.id.Id) – the Id of the AssessmentTaken
• bank_id (osid.id.Id) – the Id of the Bank

Raise:

NotFound – assessment_taken_id or bank_id not found or assessment_taken_id not assigned to bank_id

Raise:

NullArgument – assessment_taken_id or bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure occurred

compliance: mandatory – This method must be implemented.

Bank.reassign_assessment_taken_to_billing(assessment_taken_id, from_bank_id, to_bank_id)

Moves an AssessmentTaken from one Bank to another.

Mappings to other Banks are unaffected.

Parameters:

• assessment_taken_id (osid.id.Id) – the Id of the AssessmentTaken
• from_bank_id (osid.id.Id) – the Id of the current Bank
• to_bank_id (osid.id.Id) – the Id of the destination Bank

Raise:

NotFound – assessment_taken_id, from_bank_id, or to_bank_id not found or assessment_taken_id not mapped to from_bank_id

Raise:

NullArgument – assessment_taken_id, from_bank_id, or to_bank_id is null

Raise:

OperationFailed – unable to complete request

Raise:

PermissionDenied – authorization failure

compliance: mandatory – This method must be implemented.