public interface RequisiteQuerySession extends OsidSession
This session provides methods for searching among Requisites.
The search query is constructed using the RequisiteQuery.
This session defines views that offer differing behaviors for searching.
Requisites may have a query record indicated by their respective
record types. The query record is accessed via the RequisiteQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRequisites()
Tests if this user can perform
Requisite searches. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
RequisiteQuery |
getRequisiteQuery()
Gets a requisite query.
|
RequisiteList |
getRequisitesByQuery(RequisiteQuery requisiteQuery)
Gets a list of
Requisites matching the given requisite
query. |
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
void |
useSequesteredRequisiteView()
The returns from the search methods omit sequestered requisites.
|
void |
useUnsequesteredRequisiteView()
All requisites are returned including sequestered requisites.
|
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 canSearchRequisites()
Requisite
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. void useSequesteredRequisiteView()
mandatory
- This method is must be implemented. void useUnsequesteredRequisiteView()
mandatory
- This method is must be implemented. RequisiteQuery getRequisiteQuery()
mandatory
- This method must be implemented. RequisiteList getRequisitesByQuery(RequisiteQuery requisiteQuery) throws OperationFailedException, PermissionDeniedException
Requisites
matching the given requisite
query.requisiteQuery
- the requisite query RequisiteList
NullArgumentException
- requisiteQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- requisiteQuery
is
not of this servicemandatory
- This method must be implemented.