public interface AssessmentOfferedSmartBankSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An AssessmentOfferedQuery
can be retrieved from
this session and mapped to this Bank
to create a virtual
collection of AssessmentsOffered.
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 AssessmentOfferedQueryInspector.
The query may be modified by converting the inspector back to an
AssessmentOfferedQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAssessmentOfferedQuery(AssessmentOfferedQuery assessmentOfferedQuery)
Applies an assessment offered query to this bank.
|
void |
applyAssessmentOfferedSequencing(AssessmentOfferedSearchOrder assessmentOfferedSearchOrder)
Applies an assessment offered search order to this bank.
|
boolean |
canManageSmartBanks()
Tests if this user can manage smart banks.
|
AssessmentOfferedQuery |
getAssessmentOfferedQuery()
Gets an assessment offered query.
|
AssessmentOfferedQuery |
getAssessmentOfferedQueryFromInspector(AssessmentOfferedQueryInspector assessmentOfferedQueryInspector)
Gets an assessment offered query from an inspector.
|
AssessmentOfferedSearchOrder |
getAssessmentOfferedSearchOrder()
Gets an assessment offered search order.
|
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
AssessmentOfferedQueryInspector |
inspectAssessmentOfferedQuery()
Gets an assessment offered 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. AssessmentOfferedQuery getAssessmentOfferedQuery()
mandatory
- This method must be implemented. AssessmentOfferedSearchOrder getAssessmentOfferedSearchOrder()
mandatory
- This method must be implemented. void applyAssessmentOfferedQuery(AssessmentOfferedQuery assessmentOfferedQuery) throws OperationFailedException, PermissionDeniedException
assessmentOfferedQuery
- the assessment offered queryNullArgumentException
- assessmentOfferedQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- assessmentOfferedQuery
not of this servicemandatory
- This method must be implemented. AssessmentOfferedQueryInspector inspectAssessmentOfferedQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAssessmentOfferedSequencing(AssessmentOfferedSearchOrder assessmentOfferedSearchOrder) throws OperationFailedException, PermissionDeniedException
assessmentOfferedSearchOrder
- the assessment offered search
orderNullArgumentException
-
assessmentOfferedSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
assessmentOfferedSearchOrder
not of this servicemandatory
- This method must be implemented. AssessmentOfferedQuery getAssessmentOfferedQueryFromInspector(AssessmentOfferedQueryInspector assessmentOfferedQueryInspector)
assessmentOfferedQueryInspector
- a assessment offered query
inspectorNullArgumentException
-
assessmentOfferedQueryInspector
is null
UnsupportedException
-
assessmentOfferedQueryInspector
is not of this servicemandatory
- This method must be implemented.