Interface AddressSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AddressSearch
extends OsidSearch

The search interface for governing address searches.

Method Summary

Modifier and Type	Method	Description
AddressSearchRecord	getAddressSearchRecord(Type addressSearchRecordType)	Gets the address search record corresponding to the given address search record Type .
void	orderAddressResults(AddressSearchOrder addressSearchOrder)	Specify an ordering to the search results.
void	searchAmongAddresses(IdList addressIds)	Execute this search among the given list of addresses.

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

searchAmongAddresses

void searchAmongAddresses(IdList addressIds)

Execute this search among the given list of addresses.

Parameters:

addressIds - list of addresses

Throws:

NullArgumentException - addressIds is null

Compliance:

mandatory - This method must be implemented.

orderAddressResults

void orderAddressResults(AddressSearchOrder addressSearchOrder)

Specify an ordering to the search results.

Parameters:

addressSearchOrder - address search order

Throws:

NullArgumentException - addressSearchOrder is null

UnsupportedException - addressSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAddressSearchRecord

AddressSearchRecord getAddressSearchRecord(Type addressSearchRecordType)
                                    throws OperationFailedException

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

Throws:

NullArgumentException - addressSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(addressSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.