public interface PlanQuerySession extends OsidSession
This session provides methods for searching Plan
objects. The search query is constructed using the PlanQuery.
The lesson record Type
also specifies the record
for the lesson query.
Plans may have a query record indicated by their respective record
types. The query record is accessed via the PlanQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchPlans()
Tests if this user can perform susbcription searches.
|
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
PlanQuery |
getPlanQuery()
Gets a plan query.
|
PlanList |
getPlansByQuery(PlanQuery planQuery)
Gets a list of plans matching the given plan query.
|
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 canSearchPlans()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not wish 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. PlanQuery getPlanQuery()
mandatory
- This method must be implemented. PlanList getPlansByQuery(PlanQuery planQuery) throws OperationFailedException, PermissionDeniedException
planQuery
- the plan query PlanList
NullArgumentException
- planQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- planQuery
is not
of this servicemandatory
- This method must be implemented.