Interface QualifierSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface QualifierSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
QualifierQueryInspector	getQualifierQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
QualifierList	getQualifiers()	Gets the qualifier list resulting from the search.
QualifierSearchResultsRecord	getQualifierSearchResultsRecord(Type qualifierSearchRecordType)	Gets the qualifier search results record corresponding to the given qualifier search record Type .This method is used to retrieve an object implementing the requested record.

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

getQualifiers

QualifierList getQualifiers()

Gets the qualifier list resulting from the search.

Returns:

the qualifier list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getQualifierQueryInspector

QualifierQueryInspector getQualifierQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getQualifierSearchResultsRecord

QualifierSearchResultsRecord getQualifierSearchResultsRecord(Type qualifierSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

qualifierSearchRecordType - a qualifier search record type

Returns:

the qualifier search results record

Throws:

NullArgumentException - qualifierSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(qualifierSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.