Interface AssessmentResultsSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssessmentResultsSession
extends OsidSession

This session is used to access the tested assessment items and their associated responses. Assessment results may also be available and is expressed as a rubric through another assessment.

Method Summary

Modifier and Type	Method	Description
boolean	areResultsAvailable(Id assessmentTakenId)	Tests if the results are available for this assessment.
boolean	canAccessAssessmentResults()	Tests if this user can take this assessment.
Bank	getBank()	Gets the Bank associated with this session.
Id	getBankId()	Gets the Bank Id associated with this session.
GradeEntryList	getGradeEntries(Id assessmentTakenId)	Gets a list of grade entries for this assessment.
ItemList	getItems(Id assessmentTakenId)	Gets the items questioned in an assessment.
ResponseList	getResponses(Id assessmentTakenId)	Gets the submitted responses.

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.

canAccessAssessmentResults

boolean canAccessAssessmentResults()

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

getItems

ItemList getItems(Id assessmentTakenId)
           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the items questioned in an assessment.

Parameters:

assessmentTakenId - Id of the AssessmentTaken

Returns:

the list of assessment questions

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.

getResponses

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

Gets the submitted responses.

Parameters:

assessmentTakenId - Id of the AssessmentTaken

Returns:

the submitted answers

Throws:

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

areResultsAvailable

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

Tests if the results are available for this assessment.

Parameters:

assessmentTakenId - Id of the AssessmentTaken

Returns:

true if results are available, false otherwise

Throws:

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradeEntries

GradeEntryList getGradeEntries(Id assessmentTakenId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of grade entries for this assessment. Each grade entry may indicate a grade or score input by multiple graders.

Parameters:

assessmentTakenId - Id of the AssessmentTaken

Returns:

a list of grade entries

Throws:

IllegalStateException - areResultsAvailable() is false

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.