public interface AssessmentTakenSmartBankSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An AssessmentTakenQuery
can be retrieved from
this session and mapped to this Bank
to create a virtual
collection of AssessmentsTaken.
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 AssessmentTakenQueryInspector.
The query may be modified by converting the inspector back to an
AssessmentTakenQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAssessmentTakenQuery(AssessmentTakenQuery assessmentTakenQuery)
Applies an assessment taken query to this bank.
|
void |
applyAssessmentTakenSequencing(AssessmentTakenSearchOrder assessmentTakenSearchOrder)
Applies an assessment taken search order to this bank.
|
boolean |
canManageSmartBanks()
Tests if this user can manage smart banks.
|
AssessmentTakenQuery |
getAssessmentTakenQuery()
Gets an assessment taken query.
|
AssessmentTakenQuery |
getAssessmentTakenQueryFromInspector(AssessmentTakenQueryInspector assessmenTakenQueryInspector)
Gets an assessment taken query from an inspector.
|
AssessmentTakenSearchOrder |
getAssessmentTakenSearchOrder()
Gets an assessment taken search order.
|
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
AssessmentTakenQueryInspector |
inspectAssessmentTakenQuery()
Gets an assessment taken 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
- authorization 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. AssessmentTakenQuery getAssessmentTakenQuery()
mandatory
- This method must be implemented. AssessmentTakenSearchOrder getAssessmentTakenSearchOrder()
mandatory
- This method must be implemented. void applyAssessmentTakenQuery(AssessmentTakenQuery assessmentTakenQuery) throws OperationFailedException, PermissionDeniedException
assessmentTakenQuery
- the assessment taken queryNullArgumentException
- assessmentTakenQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- assessmentTakenQuery
not of this servicemandatory
- This method must be implemented. AssessmentTakenQueryInspector inspectAssessmentTakenQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAssessmentTakenSequencing(AssessmentTakenSearchOrder assessmentTakenSearchOrder) throws OperationFailedException, PermissionDeniedException
assessmentTakenSearchOrder
- the assessment taken search orderNullArgumentException
-
assessmentTakenSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
assessmentTakenSearchOrder
not of this servicemandatory
- This method must be implemented. AssessmentTakenQuery getAssessmentTakenQueryFromInspector(AssessmentTakenQueryInspector assessmenTakenQueryInspector)
assessmenTakenQueryInspector
- a assessment taen query inspectorNullArgumentException
-
assessmenTakenQueryInspector
is null
UnsupportedException
-
assessmenTakenQueryInspector
is not of this servicemandatory
- This method must be implemented.