public interface TodoProducerChecklistSession extends OsidSession
This session provides methods to retrieve TodoProducer
to Checklist
mappings. A TodoProducer
may
appear in multiple Checklist
objects. Each checklist may
have its own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupTodoProducerChecklistMappings()
Tests if this user can perform lookups of todo producer/checklist
mappings.
|
IdList |
getChecklistIdsByTodoProducer(Id todoProducerId)
Gets the
Checklist Ids mapped to a
TodoProducer. |
ChecklistList |
getChecklistsByTodoProducer(Id todoProducerId)
Gets the
Checklists mapped to a TodoProducer. |
IdList |
getTodoProducerIdsByChecklist(Id checklistId)
Gets the list of
TodoProducerIds associated with an
Checklist. |
IdList |
getTodoProducerIdsByChecklists(IdList checklistIds)
Gets the list of
TodoProducer Ids corresponding to a
list of Checklists. |
TodoProducerList |
getTodoProducersByChecklist(Id checklistId)
Gets the list of todo producers associated with an
Checklist. |
TodoProducerList |
getTodoProducersByChecklists(IdList checklistIds)
Gets the list of todo producers corresponding to a list of
Checklists. |
void |
useComparativeTodoProducerChecklistView()
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 |
usePlenaryTodoProducerChecklistView()
A complete view of the
TodoProducer and
Checklist returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupTodoProducerChecklistMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeTodoProducerChecklistView()
mandatory
- This method is must be implemented. void usePlenaryTodoProducerChecklistView()
TodoProducer
and
Checklist
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. IdList getTodoProducerIdsByChecklist(Id checklistId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TodoProducerIds
associated with an
Checklist.
checklistId
- Id
of the Checklist
Ids
NotFoundException
- checklistId
is not
foundNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TodoProducerList getTodoProducersByChecklist(Id checklistId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Checklist.
checklistId
- Id
of the Checklist
NotFoundException
- checklistId
is not
foundNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getTodoProducerIdsByChecklists(IdList checklistIds) throws OperationFailedException, PermissionDeniedException
TodoProducer Ids
corresponding to a
list of Checklists.
checklistIds
- list of checklist Ids
Ids
NullArgumentException
- checklistIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TodoProducerList getTodoProducersByChecklists(IdList checklistIds) throws OperationFailedException, PermissionDeniedException
Checklists.
checklistIds
- list of checklist Ids
NullArgumentException
- checklistIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getChecklistIdsByTodoProducer(Id todoProducerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Checklist
Ids
mapped to a
TodoProducer.
todoProducerId
- Id
of a TodoProducer
NotFoundException
- todoProducerId
is
not foundNullArgumentException
- todoProducerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ChecklistList getChecklistsByTodoProducer(Id todoProducerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Checklists
mapped to a TodoProducer.
todoProducerId
- Id
of a TodoProducer
NotFoundException
- todoProducerId
is
not foundNullArgumentException
- todoProducerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.