public interface AssessmentEntryQuerySession extends OsidSession
This session provides methods for searching among
AssessmentEntries.
The search query is constructed using the
AssessmentEntryQuery.
This session defines views that offer differing behaviors for searching.
AssessmentEntries may have a query record indicated by their
respective record types. The query record is accessed via the
AssessmentEntryQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAssessmentEntries()
Tests if this user can perform
AssessmentEntry
searches. |
AssessmentEntryList |
getAssessmentEntriesByQuery(AssessmentEntryQuery assessmentEntryQuery)
Gets a list of
AssessmentEntries matching the given
assessment entry query. |
AssessmentEntryQuery |
getAssessmentEntryQuery()
Gets an assessment entry query.
|
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchAssessmentEntries()
AssessmentEntry
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 application that may opt not
to offer search operations to unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. AssessmentEntryQuery getAssessmentEntryQuery()
mandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesByQuery(AssessmentEntryQuery assessmentEntryQuery) throws OperationFailedException, PermissionDeniedException
AssessmentEntries
matching the given
assessment entry query.assessmentEntryQuery
- the assessment entry query AssessmentEntryList
NullArgumentException
- assessmentEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- assessmentEntryQuery
is not of this servicemandatory
- This method must be implemented.