Interface ChecklistSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ChecklistSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
ChecklistQueryInspector	getChecklistQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
ChecklistList	getChecklists()	Gets the checklist list resulting from a search.
ChecklistSearchResultsRecord	getChecklistSearchResultsRecord(Type checklistSearchRecordType)	Gets the checklist search results record corresponding to the given checklist search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getChecklists

ChecklistList getChecklists()

Gets the checklist list resulting from a search.

Returns:

the checklist list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getChecklistQueryInspector

ChecklistQueryInspector getChecklistQueryInspector()

Gets the inspector for the query to examine the terns used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getChecklistSearchResultsRecord

ChecklistSearchResultsRecord getChecklistSearchResultsRecord(Type checklistSearchRecordType)
                                                      throws OperationFailedException

Gets the checklist search results 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 results record

Throws:

NullArgumentException - ChecklistSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(checklistSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.