Interface DistributorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DistributorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
DistributorQueryInspector	getDistributorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
DistributorList	getDistributors()	Gets the distributor list resulting from a search.
DistributorSearchResultsRecord	getDistributorSearchResultsRecord(Type distributorSearchRecordType)	Gets the distributor search results record corresponding to the given distributor 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

getDistributors

DistributorList getDistributors()

Gets the distributor list resulting from a search.

Returns:

the distributor list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getDistributorQueryInspector

DistributorQueryInspector getDistributorQueryInspector()

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

Returns:

the distributor query inspector

Compliance:

mandatory - This method must be implemented.

getDistributorSearchResultsRecord

DistributorSearchResultsRecord getDistributorSearchResultsRecord(Type distributorSearchRecordType)
                                                          throws OperationFailedException

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

Throws:

NullArgumentException - distributorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(distributorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.