Interface AssessmentBasicAuthoringSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssessmentBasicAuthoringSession
extends OsidSession

This session defines methods to manage assessment items in an assessment. This session is used for simple assessments without sections or parts. Updating the items on an assessment authored with sections and parts may result in an error.

Method Summary

Modifier and Type	Method	Description
void	addItem(Id assessmentId, Id itemId)	Adds an existing Item to an assessment.
boolean	canAuthorAssessments()	Tests if this user can author assessments.
Bank	getBank()	Gets the Bank associated with this session.
Id	getBankId()	Gets the Bank Id associated with this session.
ItemList	getItems(Id assessmentId)	Gets the items in sequence from an assessment.
void	moveItem(Id assessmentId, Id itemId, Id precedingItemId)	Moves an existing item to follow another item in an assessment.
void	orderItems(Id[] itemIds, Id assessmentId)	Sequences existing items in an assessment.
void	removeItem(Id assessmentId, Id itemId)	Removes an Item from this assessment.

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.

canAuthorAssessments

boolean canAuthorAssessments()

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

Compliance:

mandatory - This method must be implemented.

getItems

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

Gets the items in sequence from an assessment.

Parameters:

assessmentId - the Id of the Assessment

Returns:

list of items

Throws:

NotFoundException - assessmentid not found

NullArgumentException - assessmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

addItem

void addItem(Id assessmentId,
 Id itemId)
      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing Item to an assessment.

Parameters:

assessmentId - the Id of the Assessment

itemId - the Id of the Item

Throws:

NotFoundException - assessmentId or itemId not found

NullArgumentException - assessmentId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

removeItem

void removeItem(Id assessmentId,
 Id itemId)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an Item from this assessment.

Parameters:

assessmentId - the Id of the Assessment

itemId - the Id of the Item

Throws:

NotFoundException - assessmentId or itemId not found or itemId not on assessmentid

NullArgumentException - assessmentId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

moveItem

void moveItem(Id assessmentId,
 Id itemId,
 Id precedingItemId)
       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

assessmentId - the Id of the Assessment

itemId - the Id of an Item

precedingItemId - the Id of a preceeding Item in the sequence

Throws:

NotFoundException - assessmentId is not found, or itemId or precedingItemId not on assessmentId

NullArgumentException - assessmentId, itemId or precedingItemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

orderItems

void orderItems(Id[] itemIds,
 Id assessmentId)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Sequences existing items in an assessment.

Parameters:

itemIds - the Id of the Items

assessmentId - the Id of the Assessment

Throws:

NotFoundException - assessmentId is not found or an itemId is not on assessmentId

NullArgumentException - assessmentId or itemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.