public interface DocetQuerySession extends OsidSession
This session provides methods for searching Docet
objects. The search query is constructed using the DocetQuery.
The docet record Type
also specifies the record for
the docet query.
Docetsmay have a query record indicated by their respective record
types. The query record is accessed via the DocetQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchDocets()
Tests if this user can perform
Docet searches. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
DocetQuery |
getDocetQuery()
Gets a docet query.
|
DocetList |
getDocetsByQuery(DocetQuery docetQuery)
Gets a list of
Docets matching the given search. |
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 canSearchDocets()
Docet
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. DocetQuery getDocetQuery()
mandatory
- This method must be implemented. DocetList getDocetsByQuery(DocetQuery docetQuery) throws OperationFailedException, PermissionDeniedException
Docets
matching the given search.docetQuery
- the docet query DocetList
NullArgumentException
- docetQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- docetQuery
is not
of this servicemandatory
- This method must be implemented.