public interface TodoProducerLookupSession extends OsidSession
This session provides methods for retrieving TodoProducers.
This session defines views that offer differing behaviors when retrieving multiple objects.
TodoProducers
with the
TodoProducerAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupTodoProducers()
Tests if this user can perform
TodoProducers lookups. |
Checklist |
getChecklist()
Gets the
Checklist associated with this session. |
Id |
getChecklistId()
Gets the
Checklist Id associated with
this session. |
TodoProducer |
getTodoProducer(Id todoProducerId)
Gets the
TodoProducer specified by its Id. |
TodoProducer |
getTodoProducerByTodo(Id todoId)
Gets a
TodoProducer by Todo. |
TodoProducerList |
getTodoProducers()
Gets all
TodoProducers. |
TodoProducerList |
getTodoProducersByGenusType(Type todoProducerGenusType)
Gets a
TodoProducerList corresponding to the given todo
producer genus Type which does not include todo
producers of genus types derived from the specified Type. |
TodoProducerList |
getTodoProducersByIds(IdList todoProducerIds)
Gets a
TodoProducerList corresponding to the given
IdList. |
TodoProducerList |
getTodoProducersByParentGenusType(Type todoProducerGenusType)
Gets a
TodoProducerList corresponding to the given todo
producer genus Type and include any additional todo
producers with genus types derived from the specified Type. |
TodoProducerList |
getTodoProducersByRecordType(Type todoProducerRecordType)
Gets a
TodoProducerList containing the given todo
producer record Type. |
void |
useActiveTodoProducerView()
Only active todo producers are returned by methods in this session.
|
void |
useAnyStatusTodoProducerView()
All active and inactive todo producers are returned by methods in this
session.
|
void |
useComparativeTodoProducerView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedChecklistView()
Federates the view for methods in this session.
|
void |
useIsolatedChecklistView()
Isolates the view for methods in this session.
|
void |
usePlenaryTodoProducerView()
A complete view of the
TodoProducer returns is desired. |
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 canLookupTodoProducers()
TodoProducers
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 opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeTodoProducerView()
mandatory
- This method is must be implemented. void usePlenaryTodoProducerView()
TodoProducer
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. void useFederatedChecklistView()
mandatory
- This method is must be implemented. void useIsolatedChecklistView()
mandatory
- This method is must be implemented. void useActiveTodoProducerView()
mandatory
- This method is must be implemented. void useAnyStatusTodoProducerView()
mandatory
- This method is must be implemented. TodoProducer getTodoProducer(Id todoProducerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TodoProducer
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
TodoProducer
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a TodoProducer
and retained for
compatibility.todoProducerId
- Id
of the TodoProducer
NotFoundException
- todoProducerId
not
foundNullArgumentException
- todoProducerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. TodoProducerList getTodoProducersByIds(IdList todoProducerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
TodoProducerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the todo producers specified in the Id
list, in the
order of the list, including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible TodoProducers
may be omitted
from the list and may present the elements in any order including
returning a unique set.todoProducerIds
- the list of Ids
to retrieve TodoProducer
listNotFoundException
- an Id was
not foundNullArgumentException
- todoProducerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TodoProducerList getTodoProducersByGenusType(Type todoProducerGenusType) throws OperationFailedException, PermissionDeniedException
TodoProducerList
corresponding to the given todo
producer genus Type
which does not include todo
producers of genus types derived from the specified Type.
In plenary mode, the returned list contains all known todo
producers or an error results. Otherwise, the returned list may
contain only those todo producers that are accessible through this
session.todoProducerGenusType
- a todo producer genus type TodoProducer
listNullArgumentException
- todoProducerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TodoProducerList getTodoProducersByParentGenusType(Type todoProducerGenusType) throws OperationFailedException, PermissionDeniedException
TodoProducerList
corresponding to the given todo
producer genus Type
and include any additional todo
producers with genus types derived from the specified Type.
In plenary mode, the returned list contains all known todo
producers or an error results. Otherwise, the returned list may
contain only those todo producers that are accessible through this
session.todoProducerGenusType
- a todo producer genus type TodoProducer
listNullArgumentException
- todoProducerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TodoProducerList getTodoProducersByRecordType(Type todoProducerRecordType) throws OperationFailedException, PermissionDeniedException
TodoProducerList
containing the given todo
producer record Type.
In plenary mode, the returned
list contains all known todo producers or an error results. Otherwise,
the returned list may contain only those todo producers that are
accessible through this session.todoProducerRecordType
- a todo producer record type TodoProducer
listNullArgumentException
- todoProducerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TodoProducer getTodoProducerByTodo(Id todoId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TodoProducer
by Todo.
In plenary
mode, the returned list contains all known todo producers or an error
results. Otherwise, the returned list may contain only those todo
producers that are accessible through this session.todoId
- a todo Id
TodoProducer
InvalidArgumentException
- from
is
greater than to
NotFoundException
- todoId
is not found
or has no producerNullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TodoProducerList getTodoProducers() throws OperationFailedException, PermissionDeniedException
TodoProducers.
In plenary mode, the returned
list contains all known todo producers or an error results. Otherwise,
the returned list may contain only those todo producers that are
accessible through this session. TodoProducer
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.