public interface ChecklistQuerySession extends OsidSession
This session provides methods for searching Checklist
objects. The search query is constructed using the ChecklistQuery.
The checklist record Type
also specifies the record
for the checklist query.
Checklists may have a query record indicated by their respective
record types. The query record is accessed via the ChecklistQuery.
The returns in this session may not be cast directly to these
interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchChecklists()
Tests if this user can perform
Checklist searches. |
ChecklistQuery |
getChecklistQuery()
Gets a checklist query.
|
ChecklistList |
getChecklistsByQuery(ChecklistQuery checklistQuery)
Gets a list of
Checklists matching the given search. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchChecklists()
Checklist
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. ChecklistQuery getChecklistQuery()
mandatory
- This method must be implemented. ChecklistList getChecklistsByQuery(ChecklistQuery checklistQuery) throws OperationFailedException, PermissionDeniedException
Checklists
matching the given search.checklistQuery
- the checklist query ChecklistList
NullArgumentException
- checklistQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- checklistQuery
is
not of this servicemandatory
- This method must be implemented.