Interface ChecklistSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ChecklistSearch
extends OsidSearch

The search interface for governing checklist searches.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongChecklists

void searchAmongChecklists(IdList checklistIds)

Execute this search among the given list of checklists.

Parameters:

checklistIds - list of checklists

Throws:

NullArgumentException - checklistIds is null

Compliance:

mandatory - This method must be implemented.

orderChecklistResults

void orderChecklistResults(ChecklistSearchOrder checklistSearchOrder)

Specify an ordering to the search results.

Parameters:

checklistSearchOrder - checklist search order

Throws:

NullArgumentException - checklistSearchOrder is null

UnsupportedException - checklistSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getChecklistSearchRecord

ChecklistSearchRecord getChecklistSearchRecord(Type checklistSearchRecordType)
                                        throws OperationFailedException

Gets the checklist search record corresponding to the given checklist search record Type . This method is used to retrieve an object implementing the requested record.

Parameters:

checklistSearchRecordType - a checklist search record type

Returns:

the checklist search record

Throws:

NullArgumentException - checklistSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(checklistSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.