public interface AssessmentPartQuerySession extends OsidSession
This session provides methods for searching among AssessmentPart
objects. The search query is constructed using the
AssessmentPartQuery.
This session defines views that offer differing behaviors for searching.
Assessment parts may have a query record indicated by their respective
record types. The query record is accessed via the
AssessmentPartQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAssessmentParts()
Tests if this user can perform
AssessmentPart lookups. |
AssessmentPartQuery |
getAssessmentPartQuery()
Gets an assessment part query.
|
AssessmentPartList |
getAssessmentPartsByQuery(AssessmentPartQuery assessmentPartQuery)
Gets a list of
AssessmentParts matching the given
assessment part 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.
|
void |
useSequesteredAssessmentPartView()
The methods in this session omit sequestered assessment parts.
|
void |
useUnsequesteredAssessmentPartView()
The methods in this session return all assessment parts, including
sequestered assessment parts.
|
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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchAssessmentParts()
AssessmentPart
lookups.
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 application that may not offer lookup 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. void useSequesteredAssessmentPartView()
mandatory
- This method is must be implemented. void useUnsequesteredAssessmentPartView()
mandatory
- This method is must be implemented. AssessmentPartQuery getAssessmentPartQuery()
mandatory
- This method must be implemented. AssessmentPartList getAssessmentPartsByQuery(AssessmentPartQuery assessmentPartQuery) throws OperationFailedException, PermissionDeniedException
AssessmentParts
matching the given
assessment part query.assessmentPartQuery
- the assessment part query AssessmentPartList
NullArgumentException
- assessmentPartQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- assessmentPartQuery
is not of this servicemandatory
- This method must be implemented.