public interface AwardEntryQuerySession extends OsidSession
This session provides methods for searching among AwardEntries.
The search query is constructed using the AwardEntryQuery.
This session defines views that offer differing behaviors for searching.
AwardEntries may have a query record indicated by their respective
record types. The query record is accessed via the AwardEntryQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAwardEntries()
Tests if this user can perform
AwardEntry searches. |
AwardEntryList |
getAwardEntriesByQuery(AwardEntryQuery awardEntryQuery)
Gets a list of
AwardEntries matching the given award
entry query. |
AwardEntryQuery |
getAwardEntryQuery()
Gets an award 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 canSearchAwardEntries()
AwardEntry
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. AwardEntryQuery getAwardEntryQuery()
mandatory
- This method must be implemented. AwardEntryList getAwardEntriesByQuery(AwardEntryQuery awardEntryQuery) throws OperationFailedException, PermissionDeniedException
AwardEntries
matching the given award
entry query.awardEntryQuery
- the award entry query AwardEntryList
NullArgumentException
- awardEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- awardEntryQuery
is not of this servicemandatory
- This method must be implemented.