org.osid.assessment.authoring

Interface AssessmentPartItemDesignSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.