OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressSearch
Implementsosid.OsidSearch
Description

The search interface for governing address searches.

MethodsearchAmongAddresses
Description

Execute this search among the given list of addresses.

Parametersosid.id.IdListaddressIdslist of addresses
ErrorsNULL_ARGUMENT addressIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAddressResults
Description

Specify an ordering to the search results.

Parametersosid.contact.AddressSearchOrderaddressSearchOrderaddress search order
ErrorsNULL_ARGUMENT addressSearchOrder is null
UNSUPPORTED addressSearchOrder is not of this service
CompliancemandatoryThis 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.TypeaddressSearchRecordTypean address search record type
Returnosid.contact.records.AddressSearchRecordthe address search record
ErrorsNULL_ARGUMENT addressSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(addressSearchRecordType) is false
CompliancemandatoryThis method must be implemented.