Interface AssessmentPartItemDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssessmentPartItemDesignSession
extends OsidSession

This session provides the means for adding items to an assessment part. The item is identified inside an assesment part using its own Id. To add the same item to the assessment part, multiple assessment parts should be used and placed at the same level in the AssessmentPart hierarchy.

Method Summary

Modifier and Type	Method	Description
void	addItem(Id itemId, Id assessmentPartId)	Appends an item to an assessment part.
boolean	canDesignAssessmentParts()	Tests if this user can manage mapping of Items to AssessmentParts .
Bank	getBank()	Gets the Bank associated with this session.
Id	getBankId()	Gets the Bank Id associated with this session.
void	moveItemAhead(Id itemId, Id assessmentPartId, Id referenceId)	Reorders items in an assessment part by moving the specified item in front of a reference item.
void	moveItemBehind(Id itemId, Id assessmentPartId, Id referenceId)	Reorders items in an assessment part by moving the specified item behind of a reference item.
void	orderItems(Id[] itemIds, Id assessmentPartId)	Reorders a set of items in an assessment part.
void	removeItem(Id itemId, Id assessmentPartId)	Removes an Item from an AssessmentPartId .

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.

canDesignAssessmentParts

boolean canDesignAssessmentParts()

Tests if this user can manage mapping of Items to AssessmentParts . 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 an application hint that may opt not to offer composition operations.

Returns:

false if assessment part composition is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addItem

void addItem(Id itemId,
 Id assessmentPartId)
      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Appends an item to an assessment part.

Parameters:

itemId - Id of the Item

assessmentPartId - Id of the AssessmentPart

Throws:

AlreadyExistsException - itemId already part of assessmentPartId

NotFoundException - itemId or assessmentPartId not found

NullArgumentException - itemId or assessmentPartId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.

moveItemAhead

void moveItemAhead(Id itemId,
 Id assessmentPartId,
 Id referenceId)
            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders items in an assessment part by moving the specified item in front of a reference item.

Parameters:

itemId - Id of the Item

assessmentPartId - Id of the AssessmentPartId

referenceId - Id of the reference Item

Throws:

NotFoundException - itemId or referenceId not found in assessmentPartId

NullArgumentException - itemId, referenceId or assessmentPartId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.

moveItemBehind

void moveItemBehind(Id itemId,
 Id assessmentPartId,
 Id referenceId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders items in an assessment part by moving the specified item behind of a reference item.

Parameters:

itemId - Id of the Item

assessmentPartId - Id of the AssessmentPartId

referenceId - Id of the reference Item

Throws:

NotFoundException - itemId or referenceId not found in assessmentPartId

NullArgumentException - itemId, referenceId or assessmentPartId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.

orderItems

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

Reorders a set of items in an assessment part.

Parameters:

itemIds - Ids for a set of Items

assessmentPartId - Id of the AssessmentPartId

Throws:

NotFoundException - assessmentPartId not found or, an itemId not related to assessmentPartId

NullArgumentException - itemIds or agendaId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeItem

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

Removes an Item from an AssessmentPartId .

Parameters:

itemId - Id of the Item

assessmentPartId - Id of the AssessmentPartId

Throws:

NotFoundException - itemId not found in assessmentPartId

NullArgumentException - itemId or assessmentPartId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.