Interface DistributorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DistributorSearch
extends OsidSearch

The search interface for governing distributor searches.

Method Summary

Modifier and Type	Method	Description
DistributorSearchRecord	getDistributorSearchRecord(Type distributorSearchRecordType)	Gets the distributor search record corresponding to the given distributor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderDistributorResults(DistributorSearchOrder distributorSearchOrder)	Specify an ordering to the search results.
void	searchAmongDistributors(IdList distributorIds)	Execute this search among the given list of distributors.

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

searchAmongDistributors

void searchAmongDistributors(IdList distributorIds)

Execute this search among the given list of distributors.

Parameters:

distributorIds - list of distributors

Throws:

NullArgumentException - distributorIds is null

Compliance:

mandatory - This method must be implemented.

orderDistributorResults

void orderDistributorResults(DistributorSearchOrder distributorSearchOrder)

Specify an ordering to the search results.

Parameters:

distributorSearchOrder - distributor search order

Throws:

NullArgumentException - distributorSearchOrder is null

UnsupportedException - distributorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDistributorSearchRecord

DistributorSearchRecord getDistributorSearchRecord(Type distributorSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

distributorSearchRecordType - a distributor search record type

Returns:

the distributor search record

Throws:

NullArgumentException - distributorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(distributorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.