Interface AssessmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssessmentSession
extends OsidSession

This session is used to take an assessment. The assessment associated with this session represents the "assessment taken" by an Agent . This session may be created using an AssessmentOffered Id retrieved from an assessment bank, and instantiating this session represents the transaction of taking an assessment. Resuming an assessment, if permitted, is performed through instantiating this session with the AssessmentTaken Id .

Assessment Items are accessed via the Question interface. A Question Id is the same as the Item Id.

This session manages the flow of control for the assessment taking process. It allows for two types of processes:

• synchronous response: Each consecutive question is only available after the previous item was submitted or skipped.
• asynchronous response: Questions may be accessed independently of response submission.

It may be the case that it is allowed to suspend and resume an assessment. canSuspend() indicates the availability of this feature. finished() indicates the assessment is complete.

This session is used in the context of an AssessmentSection . An assessment with no sections defined is assumed to have a single default section that maps to the entire assessment.

Method Summary

Modifier and Type	Method	Description
boolean	canTakeAssessments()	Tests if this user can take this assessment section.
void	clearResponse(Id assessmentSectionId, Id itemId)	Clears the response to an item The item appears as unanswered.
void	finishAssessment(Id assessmentTakenId)	Indicates the entire assessment is complete.
void	finishAssessmentSection(Id assessmentSectionId)	Indicates an assessment section is complete.
void	finishedAssessment(Id assessmentTakenId)	Indicates the entire assessment is complete.
void	finishedAssessmentSection(Id assessmentSectionId)	Indicates an assessment section is complete.
AnswerList	getAnswers(Id assessmentSectionId, Id itemId)	Gets the acceptable answers to the associated item.
AssessmentSection	getAssessmentSection(Id assessmentSectionId)	Gets an assessemnts section by Id .
AssessmentSectionList	getAssessmentSections(Id assessmentTakenId)	Gets the assessment sections of this assessment.
Bank	getBank()	Gets the Bank associated with this session.
Id	getBankId()	Gets the Bank Id associated with this session.
AssessmentSection	getFirstAssessmentSection(Id assessmentTakenId)	Gets the first assessment section in this assesment.
Question	getFirstQuestion(Id assessmentSectionId)	Gets the first question in this assesment section.
Question	getFirstUnansweredQuestion(Id assessmentSectionId)	Gets the first unanswered question in this assesment section.
AssessmentSectionList	getIncompleteAssessmentSections(Id assessmentTakenId)	Gets the incomplete assessment sections of this assessment.
AssessmentSection	getNextAssessmentSection(Id assessmentSectionId)	Gets the next assessemnt section following the given assesment section.
Question	getNextQuestion(Id assessmentSectionId, Id itemId)	Gets the next question in this assesment section.
Question	getNextUnansweredQuestion(Id assessmentSectionId, Id itemId)	Gets the next unanswered question in this assesment section.
AssessmentSection	getPreviousAssessmentSection(Id assessmentSectionId)	Gets the next assessemnt section following the given assesment section.
Question	getPreviousQuestion(Id assessmentSectionId, Id itemId)	Gets the previous question in this assesment section.
Question	getPreviousUnansweredQuestion(Id assessmentSectionId, Id itemId)	Gets the previous unanswered question in this assesment section.
Question	getQuestion(Id assessmentSectionId, Id itemId)	Gets the Question specified by its Id .
QuestionList	getQuestions(Id assessmentSectionId)	Gets the questions of this assessment section.
Response	getResponse(Id assessmentSectionId, Id itemId)	Gets the submitted response to the associated item.
AnswerForm	getResponseForm(Id assessmentSectionId, Id itemId)	Gets the response form for submitting an answer.
ResponseList	getResponses(Id assessmentSectionId)	Gets all submitted responses.
QuestionList	getUnansweredQuestions(Id assessmentSectionId)	Gets the unanswered questions of this assessment section.
boolean	hasAssessmentBegun(Id assessmentTakenId)	Tests if this assessment has started.
boolean	hasAssessmentSectionBegun(Id assessmentSectionId)	Tests if this assessment section has started.
boolean	hasNextAssessmentSection(Id assessmentSectionId)	Tests if there is a next assessment section in the assessment following the given assessment section Id .
boolean	hasNextQuestion(Id assessmentSectionId, Id itemId)	Tests if there is a next question following the given question Id .
boolean	hasNextUnansweredQuestion(Id assessmentSectionId, Id itemId)	Tests if there is a next unanswered question following the given question Id .
boolean	hasPreviousAssessmentSection(Id assessmentSectionId)	Tests if there is a previous assessment section in the assessment following the given assessment section Id .
boolean	hasPreviousQuestion(Id assessmentSectionId, Id itemId)	Tests if there is a previous question preceeding the given question Id .
boolean	hasPreviousUnansweredQuestion(Id assessmentSectionId, Id itemId)	Tests if there is a previous unanswered question preceeding the given question Id .
boolean	hasUnansweredQuestions(Id assessmentSectionId)	Tests if there are unanswered questions in this assessment section.
boolean	isAnswerAvailable(Id assessmentSectionId, Id itemId)	Tests if an answer is available for the given item.
boolean	isAssessmentOver(Id assessmentTakenId)	Tests if this assessment is over.
boolean	isAssessmentSectionComplete(Id assessmentSectionId)	Tests if the all responses have been submitted to this assessment section.
boolean	isAssessmentSectionOver(Id assessmentSectionId)	Tests if this assessment section is over.
boolean	isQuestionAnswered(Id assessmentSectionId, Id itemId)	Tests if the given item has a response.
boolean	requiresSynchronousResponses(Id assessmentSectionId)	Tests if synchronous responses are required in this assessment section.
boolean	requiresSynchronousSections(Id assessmentTakenId)	Tests if synchronous sections are required.
void	skipItem(Id assessmentSectionId, Id itemId)	Skips an item.
void	submitResponse(Id assessmentSectionId, Id itemId, AnswerForm answerForm)	Submits an answer to an item.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getBankId

Id getBankId()

Gets the Bank Id associated with this session.

Returns:

the Bank Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBank

Bank getBank()
      throws OperationFailedException,
PermissionDeniedException

Gets the Bank associated with this session.

Returns:

the Bank associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canTakeAssessments

boolean canTakeAssessments()

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

Compliance:

mandatory - This method must be implemented.

hasAssessmentBegun

boolean hasAssessmentBegun(Id assessmentTakenId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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:

assessmentTakenId - Id of the AssessmentTaken

Returns:

true if this assessment has begun, false otherwise

Throws:

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

isAssessmentOver

boolean isAssessmentOver(Id assessmentTakenId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

assessmentTakenId - Id of the AssessmentTaken

Returns:

true if this assessment is over, false otherwise

Throws:

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

finishedAssessment

void finishedAssessment(Id assessmentTakenId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Indicates the entire assessment is complete.

Parameters:

assessmentTakenId - Id of the AssessmentTaken

Throws:

IllegalStateException - hasBegun() is false or isOver() is true

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

requiresSynchronousSections

boolean requiresSynchronousSections(Id assessmentTakenId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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, hasNextSection() 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:

assessmentTakenId - Id of the AssessmentTaken

Returns:

true if this synchronous sections are required, false otherwise

Throws:

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getFirstAssessmentSection

AssessmentSection getFirstAssessmentSection(Id assessmentTakenId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the first assessment section in this assesment. All assessments have at least one AssessmentSection .

Parameters:

assessmentTakenId - Id of the AssessmentTaken

Returns:

the first assessment section

Throws:

IllegalStateException - hasAssessmentBegun() is false

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

hasNextAssessmentSection

boolean hasNextAssessmentSection(Id assessmentSectionId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

true if there is a next section, false otherwise

Throws:

IllegalStateException - hasAssessmentBegun() is false

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getNextAssessmentSection

AssessmentSection getNextAssessmentSection(Id assessmentSectionId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the next assessemnt section following the given assesment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

the next section

Throws:

IllegalStateException - hasNextAssessmentSection() is false

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

hasPreviousAssessmentSection

boolean hasPreviousAssessmentSection(Id assessmentSectionId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

true if there is a previous assessment section, false otherwise

Throws:

IllegalStateException - hasAssessmentBegun() is false

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getPreviousAssessmentSection

AssessmentSection getPreviousAssessmentSection(Id assessmentSectionId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the next assessemnt section following the given assesment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

the previous assessment section

Throws:

IllegalStateException - hasNextAssessmentSection() is false

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getAssessmentSection

AssessmentSection getAssessmentSection(Id assessmentSectionId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets an assessemnts section by Id .

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

the assessment section

Throws:

IllegalStateException - hasAssessmentBegun() is false

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getAssessmentSections

AssessmentSectionList getAssessmentSections(Id assessmentTakenId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the assessment sections of this assessment.

Parameters:

assessmentTakenId - Id of the AssessmentTaken

Returns:

the list of assessment sections

Throws:

IllegalStateException - hasAssessmentBegun() is false

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

isAssessmentSectionComplete

boolean isAssessmentSectionComplete(Id assessmentSectionId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the all responses have been submitted to this assessment section. If isAssessmentSectionComplete() is false, then getUnansweredQuestions() may return a list of questions that can be submitted.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

true if this assessment section is complete, false otherwise

Throws:

IllegalStateException - isAssessmentOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIncompleteAssessmentSections

AssessmentSectionList getIncompleteAssessmentSections(Id assessmentTakenId)
                                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the incomplete assessment sections of this assessment.

Parameters:

assessmentTakenId - Id of the AssessmentTaken

Returns:

the list of incomplete assessment sections

Throws:

IllegalStateException - hasAssessmentBegun() is false

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

hasAssessmentSectionBegun

boolean hasAssessmentSectionBegun(Id assessmentSectionId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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:

assessmentSectionId - Id of the AssessmentSection

Returns:

true if this assessment section has begun, false otherwise

Throws:

IllegalStateException - hasAssessmentBegun() is false or isAssessmentOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAssessmentSectionOver

boolean isAssessmentSectionOver(Id assessmentSectionId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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:

assessmentSectionId - Id of the AssessmentSection

Returns:

true if this assessment is over, false otherwise

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

finishedAssessmentSection

void finishedAssessmentSection(Id assessmentSectionId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Indicates an assessment section is complete.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

requiresSynchronousResponses

boolean requiresSynchronousResponses(Id assessmentSectionId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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 hasNextQuestion() and getNextQuestion() methods. In synchronous mode, hasNextQuestion() is false until the response for the current question is submitted. In asynchronous mode, hasNextQuestion() 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:

assessmentSectionId - Id of the AssessmentSection

Returns:

true if this synchronous responses are required, false otherwise

Throws:

IllegalStateException - hasAssessmentBegun() is false or isAssessmentOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFirstQuestion

Question getFirstQuestion(Id assessmentSectionId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the first question in this assesment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

the first question

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

hasNextQuestion

boolean hasNextQuestion(Id assessmentSectionId,
 Id itemId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

true if there is a next question, false otherwise

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getNextQuestion

Question getNextQuestion(Id assessmentSectionId,
 Id itemId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the next question in this assesment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

the next question

Throws:

IllegalStateException - hasNextQuestion() is false

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

hasPreviousQuestion

boolean hasPreviousQuestion(Id assessmentSectionId,
 Id itemId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

true if there is a previous question, false otherwise

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getPreviousQuestion

Question getPreviousQuestion(Id assessmentSectionId,
 Id itemId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the previous question in this assesment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

the previous question

Throws:

IllegalStateException - hasPreviousQuestion() is false

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getQuestion

Question getQuestion(Id assessmentSectionId,
 Id itemId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Question specified by its Id .

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

the returned Question

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getQuestions

QuestionList getQuestions(Id assessmentSectionId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the questions of this assessment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

the list of assessment questions

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getResponseForm

AnswerForm getResponseForm(Id assessmentSectionId,
 Id itemId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the response form for submitting an answer.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

an answer form

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

submitResponse

void submitResponse(Id assessmentSectionId,
 Id itemId,
 AnswerForm answerForm)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Submits an answer to an item.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

answerForm - the response

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true , or answerForm was already used in a submit transaction

InvalidArgumentException - one or more of the elements in the form is invalid

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId, itemId , or answerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - answerForm is not of this service

Compliance:

mandatory - This method must be implemented.

skipItem

void skipItem(Id assessmentSectionId,
 Id itemId)
       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Skips an item.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isQuestionAnswered

boolean isQuestionAnswered(Id assessmentSectionId,
 Id itemId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the given item has a response.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

true if this item has a response, false otherwise

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUnansweredQuestions

QuestionList getUnansweredQuestions(Id assessmentSectionId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the unanswered questions of this assessment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

the list of questions with no rsponses

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

hasUnansweredQuestions

boolean hasUnansweredQuestions(Id assessmentSectionId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if there are unanswered questions in this assessment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

true if there are unanswered questions, false otherwise

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getFirstUnansweredQuestion

Question getFirstUnansweredQuestion(Id assessmentSectionId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the first unanswered question in this assesment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

the first unanswered question

Throws:

IllegalStateException - hasUnansweredQuestions() is false

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

hasNextUnansweredQuestion

boolean hasNextUnansweredQuestion(Id assessmentSectionId,
 Id itemId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

true if there is a next unanswered question, false otherwise

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getNextUnansweredQuestion

Question getNextUnansweredQuestion(Id assessmentSectionId,
 Id itemId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the next unanswered question in this assesment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

the next unanswered question

Throws:

IllegalStateException - hasNextUnansweredQuestion() is false

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

hasPreviousUnansweredQuestion

boolean hasPreviousUnansweredQuestion(Id assessmentSectionId,
 Id itemId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

true if there is a previous unanswered question, false otherwise

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getPreviousUnansweredQuestion

Question getPreviousUnansweredQuestion(Id assessmentSectionId,
 Id itemId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the previous unanswered question in this assesment section.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

the previous unanswered question

Throws:

IllegalStateException - hasPreviousUnansweredQuestion() is false

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getResponse

Response getResponse(Id assessmentSectionId,
 Id itemId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the submitted response to the associated item.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

the response

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getResponses

ResponseList getResponses(Id assessmentSectionId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all submitted responses.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Returns:

the list of responses

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

clearResponse

void clearResponse(Id assessmentSectionId,
 Id itemId)
            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Clears the response to an item The item appears as unanswered. If no response exists, the method simply returns.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

finishAssessmentSection

void finishAssessmentSection(Id assessmentSectionId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Indicates an assessment section is complete. Finished sections may or may not allow new or updated responses.

Parameters:

assessmentSectionId - Id of the AssessmentSection

Throws:

IllegalStateException - hasAssessmentSectionBegun() is false or isAssessmentSectionOver() is true

NotFoundException - assessmentSectionId is not found

NullArgumentException - assessmentSectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAnswerAvailable

boolean isAnswerAvailable(Id assessmentSectionId,
 Id itemId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an answer is available for the given item.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

true if an answer are available, false otherwise

Throws:

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAnswers

AnswerList getAnswers(Id assessmentSectionId,
 Id itemId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the acceptable answers to the associated item.

Parameters:

assessmentSectionId - Id of the AssessmentSection

itemId - Id of the Item

Returns:

the answers

Throws:

IllegalStateException - isAnswerAvailable() is false

NotFoundException - assessmentSectionId or itemId is not found, or itemId not part of assessmentSectionId

NullArgumentException - assessmentSectionId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

finishAssessment

void finishAssessment(Id assessmentTakenId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Indicates the entire assessment is complete.

Parameters:

assessmentTakenId - Id of the AssessmentTaken

Throws:

IllegalStateException - hasBegun() is false or isOver() is true

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.