public interface AssessmentQuerySession extends OsidSession
This session provides methods for querying Assessment
objects. The search query is constructed using the AssessmentQuery.
This session defines views that offer differing behaviors for searching.
Assessments may have a query record indicated by their respective
record types. The query record is accessed via the AssessmentQuery.
The returns in this session may not be cast directly to these
interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAssessments()
Tests if this user can perform
Assessment searches. |
AssessmentQuery |
getAssessmentQuery()
Gets an assessment query.
|
AssessmentList |
getAssessmentsByQuery(AssessmentQuery assessmentQuery)
Gets a list of
Assessments matching the given
assessment query. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
useFederatedBankView()
Federates the view for methods in this session.
|
void |
useIsolatedBankView()
Isolates the view for methods in this session.
|
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 canSearchAssessments()
Assessment
searches. 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 a
hint to an pplication that may wish not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedBankView()
mandatory
- This method is must be implemented. void useIsolatedBankView()
mandatory
- This method is must be implemented. AssessmentQuery getAssessmentQuery()
mandatory
- This method must be implemented. AssessmentList getAssessmentsByQuery(AssessmentQuery assessmentQuery) throws OperationFailedException, PermissionDeniedException
Assessments
matching the given
assessment query.assessmentQuery
- the assessment query AssessmentList
NullArgumentException
- assessmentQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- assessmentQuery
is not of this servicemandatory
- This method must be implemented.