OSID Logo
OSID Specifications
contact package
Version 3.1.0
Interfaceosid.contact.AddressSearch
Implementsosid.OsidSearch
Used Byosid.contact.AddressSearchSession
Description

The search interface for governing address searches.

MethodsearchAmongAddresses
Description

Execute this search among the given list of addresses.

Parametersosid.id.IdListaddressIds list of addresses
ErrorsNULL_ARGUMENT addressIds is null
Compliancemandatory This method must be implemented.
MethodorderAddressResults
Description

Specify an ordering to the search results.

Parametersosid.contact.AddressSearchOrderaddressSearchOrder address search order
ErrorsNULL_ARGUMENT addressSearchOrder is null
UNSUPPORTED addressSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetAddressSearchRecord
Description

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.

Parametersosid.type.TypeaddressSearchRecordType an address search record type
Returnosid.contact.records.AddressSearchRecord the address search record
ErrorsNULL_ARGUMENT addressSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(addressSearchRecordType) is false
Compliancemandatory This method must be implemented.