public interface ChecklistSearch extends OsidSearch
The search interface for governing checklist searches.
Modifier and Type | Method and Description |
---|---|
ChecklistSearchRecord |
getChecklistSearchRecord(Type checklistSearchRecordType)
Gets the checklist search record corresponding to the given checklist
search record
Type. |
void |
orderChecklistResults(ChecklistSearchOrder checklistSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongChecklists(IdList checklistIds)
Execute this search among the given list of checklists.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongChecklists(IdList checklistIds)
checklistIds
- list of checklistsNullArgumentException
- checklistIds
is
null
mandatory
- This method must be implemented. void orderChecklistResults(ChecklistSearchOrder checklistSearchOrder)
checklistSearchOrder
- checklist search orderNullArgumentException
- checklistSearchOrder
is null
UnsupportedException
- checklistSearchOrder
is not of this servicemandatory
- This method must be implemented. ChecklistSearchRecord getChecklistSearchRecord(Type checklistSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.checklistSearchRecordType
- a checklist search record typeNullArgumentException
-
checklistSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(checklistSearchRecordType)
is
false
mandatory
- This method must be implemented.