Interface QualifierSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface QualifierSearch
extends OsidSearch

QualifierSearch defines the interface for specifying qualifier search options.

Method Summary

Modifier and Type	Method	Description
QualifierSearchRecord	getQualifierSearchRecord(Type qualifierSearchRecordType)	Gets the qualifier search record corresponding to the given qualifier search record Type .
void	orderQualifierResults(QualifierSearchOrder qualifierSearchOrder)	Specify an ordering to the search results.
void	searchAmongQualifiers(IdList qualifierIds)	Execute this search among the given list of qualifiers.

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

searchAmongQualifiers

void searchAmongQualifiers(IdList qualifierIds)

Execute this search among the given list of qualifiers.

Parameters:

qualifierIds - list of qualifiers

Throws:

NullArgumentException - qualifierIds is null

Compliance:

mandatory - This method must be implemented.

orderQualifierResults

void orderQualifierResults(QualifierSearchOrder qualifierSearchOrder)

Specify an ordering to the search results.

Parameters:

qualifierSearchOrder - qualifier search order

Throws:

NullArgumentException - qualifierSearchOrder is null

UnsupportedException - qualifierSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getQualifierSearchRecord

QualifierSearchRecord getQualifierSearchRecord(Type qualifierSearchRecordType)
                                        throws OperationFailedException

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

Throws:

NullArgumentException - qualifierSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(qualifierSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.