Interface MyAssessmentTakenSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface MyAssessmentTakenSession
extends OsidSession

This session defines methods for retrieving assessments taken by the authenticated agent. An AssessmentTaken is created using the AssessmentTakenAdminSession.

Assessments taken may have an additional records indicated by their respective record types. The record is accessed via the AssessmentTaken. The returns may not be cast directly from the returns in the lookup methods.

Method Summary

Modifier and Type	Method	Description
boolean	canGetMyTakenAssessments()	Tests if this user can perform AssessmentOffered lookups.
AssessmentTakenList	getAssessmentsCompleted()	Gets all the assessments completed by this agent.
AssessmentTakenList	getAssessmentsInProgress()	Gets all the assessments started but not completed by this agent.
AssessmentTakenList	getAssessmentsInProgressDuring(DateTime start, DateTime end)	Gets all the assessments in progress by this agent overlapping with the given period of time inclusive.
AssessmentTakenList	getAssessmentsStarted()	Gets all the assessments started by this agent.
AssessmentTakenList	getAssessmentsStartedDuring(DateTime start, DateTime end)	Gets all the assessments started by this agent during the given period of time inclusive.
Bank	getBank()	Gets the Bank associated with this session.
Id	getBankId()	Gets the Bank Id associated with this session.

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.

canGetMyTakenAssessments

boolean canGetMyTakenAssessments()

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

Compliance:

mandatory - This method must be implemented.

getAssessmentsStartedDuring

AssessmentTakenList getAssessmentsStartedDuring(DateTime start,
 DateTime end)
                                         throws OperationFailedException,
PermissionDeniedException

Gets all the assessments started by this agent during the given period of time inclusive.

Parameters:

start - start time

end - end time

Returns:

the started assessments

Throws:

InvalidArgumentException - end is less than start

NullArgumentException - start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getAssessmentsStarted

AssessmentTakenList getAssessmentsStarted()
                                   throws OperationFailedException,
PermissionDeniedException

Gets all the assessments started by this agent.

Returns:

the started assessments

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getAssessmentsInProgressDuring

AssessmentTakenList getAssessmentsInProgressDuring(DateTime start,
 DateTime end)
                                            throws OperationFailedException,
PermissionDeniedException

Gets all the assessments in progress by this agent overlapping with the given period of time inclusive.

Parameters:

start - start time

end - end time

Returns:

the in progress assessments

Throws:

InvalidArgumentException - end is less than start

NullArgumentException - start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getAssessmentsInProgress

AssessmentTakenList getAssessmentsInProgress()
                                      throws OperationFailedException,
PermissionDeniedException

Gets all the assessments started but not completed by this agent.

Returns:

the assessments in progress

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getAssessmentsCompleted

AssessmentTakenList getAssessmentsCompleted()
                                     throws OperationFailedException,
PermissionDeniedException

Gets all the assessments completed by this agent.

Returns:

the completed assessments

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.