Interface AddressSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AddressSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AddressList	getAddresses()	Gets the address list resulting from a search.
AddressQueryInspector	getAddressQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
AddressSearchResultsRecord	getAddressSearchResultsRecord(Type addressSearchRecordType)	Gets the address search results record corresponding to the given address search record Type.

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

getAddresses

AddressList getAddresses()

Gets the address list resulting from a search.

Returns:

the address list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAddressQueryInspector

AddressQueryInspector getAddressQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getAddressSearchResultsRecord

AddressSearchResultsRecord getAddressSearchResultsRecord(Type addressSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

addressSearchRecordType - an address search record type

Returns:

the address search results record

Throws:

NullArgumentException - AddressSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(addressSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.