Interface CustomerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CustomerSearch
extends OsidSearch

The search interface for governing customer searches.

Method Summary

Modifier and Type	Method	Description
CustomerSearchRecord	getCustomerSearchRecord(Type customerSearchRecordType)	Gets the customer search record corresponding to the given customer search record Type.
void	orderCustomerResults(CustomerSearchOrder customerSearchOrder)	Specify an ordering to the search results.
void	searchAmongCustomers(IdList customerIds)	Execute this search among the given list of customers.

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

searchAmongCustomers

void searchAmongCustomers(IdList customerIds)

Execute this search among the given list of customers.

Parameters:

customerIds - list of customers

Throws:

NullArgumentException - customerIds is null

Compliance:

mandatory - This method must be implemented.

orderCustomerResults

void orderCustomerResults(CustomerSearchOrder customerSearchOrder)

Specify an ordering to the search results.

Parameters:

customerSearchOrder - customer search order

Throws:

NullArgumentException - customerSearchOrder is null

UnsupportedException - customerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCustomerSearchRecord

CustomerSearchRecord getCustomerSearchRecord(Type customerSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

customerSearchRecordType - a customer search record type

Returns:

the customer search record

Throws:

NullArgumentException - customerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(customerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.