public interface CustomerSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and 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. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
CustomerList getCustomers()
IllegalStateException
- the customer list has already
been retrievedmandatory
- This method must be implemented. CustomerQueryInspector getCustomerQueryInspector()
mandatory
- This method must be implemented. CustomerSearchResultsRecord getCustomerSearchResultsRecord(Type customerSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.customerSearchRecordType
- a customer search record typeNullArgumentException
- customerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(customerSearchRecordType)
is
false
mandatory
- This method must be implemented.