public interface TodoProducerQuerySession extends OsidSession
This session provides methods for searching among TodoProducer
objects. The search query is constructed using the
TodoProducerQuery.
This session defines views that offer differing behaviors for searching.
Todo producers may have a query record indicated by their respective
record types. The query record is accessed via the
TodoProducerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchTodoProducers()
Tests if this user can perform
TodoProducer lookups. |
Checklist |
getChecklist()
Gets the
Checklist associated with this session. |
Id |
getChecklistId()
Gets the
Checklist Id associated with
this session. |
TodoProducerQuery |
getTodoProducerQuery()
Gets a todo producer query.
|
TodoProducerList |
getTodoProducersByQuery(TodoProducerQuery todoProducerQuery)
Gets a list of
TodoProducers matching the given todo
producer query. |
void |
useFederatedChecklistView()
Federates the view for methods in this session.
|
void |
useIsolatedChecklistView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getChecklistId()
Checklist
Id
associated with
this session. Checklist Id
associated with this sessionmandatory
- This method must be implemented. Checklist getChecklist() throws OperationFailedException, PermissionDeniedException
Checklist
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchTodoProducers()
TodoProducer
lookups. 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 not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedChecklistView()
mandatory
- This method is must be implemented. void useIsolatedChecklistView()
mandatory
- This method is must be implemented. TodoProducerQuery getTodoProducerQuery()
mandatory
- This method must be implemented. TodoProducerList getTodoProducersByQuery(TodoProducerQuery todoProducerQuery) throws OperationFailedException, PermissionDeniedException
TodoProducers
matching the given todo
producer query.todoProducerQuery
- the todo producer query TodoProducerList
NullArgumentException
- todoProducerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- todoProducerQuery
is not of this servicemandatory
- This method must be implemented.