Interface ValueEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ValueEnablerSearch
extends OsidSearch

The search interface for governing value enabler searches.

Method Summary

Modifier and Type	Method	Description
ValueEnablerSearchRecord	getValueEnablerSearchRecord(Type valueEnablerSearchRecordType)	Gets the value enabler search record corresponding to the given value enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderValueEnablerResults(ValueEnablerSearchOrder valueEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongValueEnablers(IdList valueEnablerIds)	Execute this search among the given list of value enablers.

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

searchAmongValueEnablers

void searchAmongValueEnablers(IdList valueEnablerIds)

Execute this search among the given list of value enablers.

Parameters:

valueEnablerIds - list of value enablers

Throws:

NullArgumentException - valueEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderValueEnablerResults

void orderValueEnablerResults(ValueEnablerSearchOrder valueEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

valueEnablerSearchOrder - value enabler search order

Throws:

NullArgumentException - valueEnablerSearchOrder is null

UnsupportedException - valueEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getValueEnablerSearchRecord

ValueEnablerSearchRecord getValueEnablerSearchRecord(Type valueEnablerSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

valueEnablerSearchRecordType - a value enabler search record type

Returns:

the value enabler search record

Throws:

NullArgumentException - valueEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(valueEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.