public interface ChecklistLookupSession extends OsidSession
This session provides methods for retrieving Checklist
objects. The Checklist
represents a collection of todos.
This session defines views that offer differing behaviors when retrieving multiple objects.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupChecklists()
Tests if this user can perform
Checklist lookups. |
Checklist |
getChecklist(Id checklistId)
Gets the
Checklist specified by its Id. |
ChecklistList |
getChecklists()
Gets all
Checklists. |
ChecklistList |
getChecklistsByGenusType(Type checklistGenusType)
Gets a
ChecklistList corresponding to the given
checklist genus Type which does not include checklists
of genus types derived from the specified Type. |
ChecklistList |
getChecklistsByIds(IdList checklistIds)
Gets a
ChecklistList corresponding to the given
IdList. |
ChecklistList |
getChecklistsByParentGenusType(Type checklistGenusType)
Gets a
ChecklistList corresponding to the given
checklist genus Type and include any additional
checklists with genus types derived from the specified Type. |
ChecklistList |
getChecklistsByProvider(Id resourceId)
Gets a
ChecklistList from the given provider. |
ChecklistList |
getChecklistsByRecordType(Type checklistRecordType)
Gets a
ChecklistList containing the given checklist
record Type. |
void |
useComparativeChecklistView()
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 |
usePlenaryChecklistView()
A complete view of the
Checklist returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupChecklists()
Checklist
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 lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeChecklistView()
mandatory
- This method is must be implemented. void usePlenaryChecklistView()
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. Checklist getChecklist(Id checklistId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Checklist
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Checklist
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Checklist
and retained for compatibility.checklistId
- Id
of the Checklist
NotFoundException
- checklistId
not
foundNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ChecklistList getChecklistsByIds(IdList checklistIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ChecklistList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
checklists 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 Checklists
may be omitted from the list
and may present the elements in any order including returning a unique
set.checklistIds
- the list of Ids
to retrieve Checklist
listNotFoundException
- an Id was
not foundNullArgumentException
- checklistIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ChecklistList getChecklistsByGenusType(Type checklistGenusType) throws OperationFailedException, PermissionDeniedException
ChecklistList
corresponding to the given
checklist genus Type
which does not include checklists
of genus types derived from the specified Type.
In
plenary mode, the returned list contains all known checklists or an
error results. Otherwise, the returned list may contain only those
checklists that are accessible through this session.checklistGenusType
- a checklist genus type Checklist
listNullArgumentException
- checklistGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ChecklistList getChecklistsByParentGenusType(Type checklistGenusType) throws OperationFailedException, PermissionDeniedException
ChecklistList
corresponding to the given
checklist genus Type
and include any additional
checklists with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
checklists or an error results. Otherwise, the returned list may
contain only those checklists that are accessible through this
session.checklistGenusType
- a checklist genus type Checklist
listNullArgumentException
- checklistGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ChecklistList getChecklistsByRecordType(Type checklistRecordType) throws OperationFailedException, PermissionDeniedException
ChecklistList
containing the given checklist
record Type.
In plenary mode, the returned list
contains all known checklists or an error results. Otherwise, the
returned list may contain only those checklists that are accessible
through this session.checklistRecordType
- a checklist record type Checklist
listNullArgumentException
- checklistRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ChecklistList getChecklistsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
ChecklistList
from the given provider. In
plenary mode, the returned list contains all known checklists or an
error results. Otherwise, the returned list may contain only those
checklists that are accessible through this session.resourceId
- a provider Id
Checklist
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ChecklistList getChecklists() throws OperationFailedException, PermissionDeniedException
Checklists.
In plenary mode, the returned list
contains all known checklists or an error results. Otherwise, the
returned list may contain only those checklists that are accessible
through this session. Checklists
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.