org.osid.assessment.authoring

Interface AssessmentPartSmartBankSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AssessmentPartSmartBankSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic bank. An AssessmentPartQuery can be retrieved from this session and mapped to this Bank to create a virtual collection of assessment parts. The assessment part may be sequenced using the AssessmentPartSearchOrder from this session.

This Bank has a default query that matches any assessment part and a default search order that specifies no sequencing. The queries may be examined using an AssessmentPartQueryInspector. The query may be modified by converting the inspector back to an AssessmentPartQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAssessmentPartQuery(AssessmentPartQuery assessmentPartQuery) Applies an assessment part query to this bank.
void	applyAssessmentPartSequencing(AssessmentPartSearchOrder assessmentPartSearchOrder) Applies an assessment part search order to this bank.
boolean	canManageSmartBanks() Tests if this user can manage smart bank.
AssessmentPartQuery	getAssessmentPartQuery() Gets an assessment part query.
AssessmentPartQuery	getAssessmentPartQueryFromInspector(AssessmentPartQueryInspector assessmentPartQueryInspector) Gets an assessment part query from an inspector.
AssessmentPartSearchOrder	getAssessmentPartSearchOrder() Gets an assessment part search order.
Bank	getBank() Gets the Bank associated with this session.
Id	getBankId() Gets the Bank Id associated with this session.
AssessmentPartQueryInspector	inspectAssessmentPartQuery() Gets an assessment part query inspector for this bank.

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartBanks

boolean canManageSmartBanks()

Tests if this user can manage smart bank. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart bank management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAssessmentPartQuery

AssessmentPartQuery getAssessmentPartQuery()

Gets an assessment part query.

Returns:

the assessment part query

Compliance:

mandatory - This method must be implemented.

getAssessmentPartSearchOrder

AssessmentPartSearchOrder getAssessmentPartSearchOrder()

Gets an assessment part search order.

Returns:

the assessment part search order

Compliance:

mandatory - This method must be implemented.

applyAssessmentPartQuery

void applyAssessmentPartQuery(AssessmentPartQuery assessmentPartQuery)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies an assessment part query to this bank.

Parameters:

assessmentPartQuery - the assessment part query

Throws:

NullArgumentException - assessmentPartQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - assessmentPartQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectAssessmentPartQuery

AssessmentPartQueryInspector inspectAssessmentPartQuery()
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets an assessment part query inspector for this bank.

Returns:

the assessment part query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyAssessmentPartSequencing

void applyAssessmentPartSequencing(AssessmentPartSearchOrder assessmentPartSearchOrder)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies an assessment part search order to this bank.

Parameters:

assessmentPartSearchOrder - the assessment part search order

Throws:

NullArgumentException - assessmentPartSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - assessmentPartSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getAssessmentPartQueryFromInspector

AssessmentPartQuery getAssessmentPartQueryFromInspector(AssessmentPartQueryInspector assessmentPartQueryInspector)

Gets an assessment part query from an inspector.

Parameters:

assessmentPartQueryInspector - an assessment part query inspector

Returns:

the assessment part query

Throws:

NullArgumentException - assessmentPartQueryInspector is null

UnsupportedException - assessmentPartQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.