public interface AssessmentSmartBankSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An AssessmentQuery
can be retrieved from this
session and mapped to this Bank
to create a virtual
collection of Assessments.
The assessments may be sequenced
using the AssessmentSearchOrder
from this session.
This Bank
has a default query that matches any
assessment and a default search order that specifies no sequencing. The
queries may be examined using an AssessmentQueryInspector.
The query may be modified by converting the inspector back to an
AssessmentQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAssessmentQuery(AssessmentQuery assessmentQuery)
Applies an assessment query to this bank.
|
void |
applyAssessmentSequencing(AssessmentSearchOrder assessmentSearchOrder)
Applies an assessment search order to this bank.
|
boolean |
canManageSmartBanks()
Tests if this user can manage smart banks.
|
AssessmentQuery |
getAssessmentQuery()
Gets an assessment query.
|
AssessmentQuery |
getAssessmentQueryFromInspector(AssessmentQueryInspector assessmentQueryInspector)
Gets an assessment query from an inspector.
|
AssessmentSearchOrder |
getAssessmentSearchOrder()
Gets an assessment search order.
|
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
AssessmentQueryInspector |
inspectAssessmentQuery()
Gets an assessment query inspector for this bank.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBankId()
Bank
Id
associated with this
session. Bank Id
associated with this sessionmandatory
- This method must be implemented. Bank getBank() throws OperationFailedException, PermissionDeniedException
Bank
associated with this session. Bank
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- assessment failuremandatory
- This method must be implemented. boolean canManageSmartBanks()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart bank management is not
authorized, true
otherwisemandatory
- This method must be implemented. AssessmentQuery getAssessmentQuery()
mandatory
- This method must be implemented. AssessmentSearchOrder getAssessmentSearchOrder()
mandatory
- This method must be implemented. void applyAssessmentQuery(AssessmentQuery assessmentQuery) throws OperationFailedException, PermissionDeniedException
assessmentQuery
- the assessment queryNullArgumentException
- assessmentQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- assessmentQuery
not of this servicemandatory
- This method must be implemented. AssessmentQueryInspector inspectAssessmentQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAssessmentSequencing(AssessmentSearchOrder assessmentSearchOrder) throws OperationFailedException, PermissionDeniedException
assessmentSearchOrder
- the assessment search orderNullArgumentException
- assessmentSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- assessmentSearchOrder
not of this servicemandatory
- This method must be implemented. AssessmentQuery getAssessmentQueryFromInspector(AssessmentQueryInspector assessmentQueryInspector)
assessmentQueryInspector
- an assessment query inspectorNullArgumentException
- assessmentQueryInspector
is null
UnsupportedException
- assessmentQueryInspector
is not of this servicemandatory
- This method must be implemented.