Interface CustomerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CustomerSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
CustomerQueryInspector	getCustomerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CustomerList	getCustomers()	Gets the customer list resulting from a search.
CustomerSearchResultsRecord	getCustomerSearchResultsRecord(Type customerSearchRecordType)	Gets the customer search results record corresponding to the given customer search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getCustomers

CustomerList getCustomers()

Gets the customer list resulting from a search.

Returns:

the customer list

Throws:

IllegalStateException - the customer list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCustomerQueryInspector

CustomerQueryInspector getCustomerQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getCustomerSearchResultsRecord

CustomerSearchResultsRecord getCustomerSearchResultsRecord(Type customerSearchRecordType)
                                                    throws OperationFailedException

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

Throws:

NullArgumentException - customerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(customerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.