Interface ConfigurationSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ConfigurationSearch
extends OsidSearch

The search interface to query a configuration.

Method Summary

Modifier and Type	Method	Description
ConfigurationSearchRecord	getConfigurationSearchRecord(Type configurationSearchRecordType)	Gets the configuration search record corresponding to the given configuration search record Type .This method is used to retrieve an object implementing the requested record.
void	orderConfigurationResults(ConfigurationSearchOrder configurationSearchOrder)	Specify an ordering to the search results.
void	searchAmongConfigurations(IdList configurationIds)	Execute this search among the given list of configurations.

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

searchAmongConfigurations

void searchAmongConfigurations(IdList configurationIds)

Execute this search among the given list of configurations.

Parameters:

configurationIds - list of configurations

Throws:

NullArgumentException - configurationIds is null

Compliance:

mandatory - This method must be implemented.

orderConfigurationResults

void orderConfigurationResults(ConfigurationSearchOrder configurationSearchOrder)

Specify an ordering to the search results.

Parameters:

configurationSearchOrder - configuration search order

Throws:

NullArgumentException - configurationSearchOrder is null

UnsupportedException - configurationSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getConfigurationSearchRecord

ConfigurationSearchRecord getConfigurationSearchRecord(Type configurationSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

configurationSearchRecordType - a configuration search record type

Returns:

the configuration search record

Throws:

NullArgumentException - configurationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(configurationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.