OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressSearchSession
Implementsosid.contact.AddressQuerySession
Description

This session provides methods for searching Address objects. The search query is constructed using the AddressQuery. The address record Type also specifies the record for the address query.

getAddressesByQuery() is the basic search method and returns a list of Address elements. A more advanced search may be performed with getAddressesBySearch(). It accepts an AddressSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAddressesBySearch() returns an AddressSearchResults that can be used to access the resulting AddressList or be used to perform a search within the result set through AddressSearch.

Addresses may have a query record indicated by their respective record types. The query record is accessed via the AddressQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetAddressSearch
Description

Gets an address search.

Returnosid.contact.AddressSearchthe address search
CompliancemandatoryThis method must be implemented.
MethodgetAddressSearchOrder
Description

Gets an address search order. The AddressSearchOrder is supplied to an AddressSearch to specify the ordering of results.

Returnosid.contact.AddressSearchOrderthe address search order
CompliancemandatoryThis method must be implemented.
MethodgetAddressesBySearch
Description

Gets the search results matching the given search.

Parametersosid.contact.AddressQueryaddressQuerythe address query
osid.contact.AddressSearchaddressSearchthe address search
Returnosid.contact.AddressSearchResultsthe address search results
ErrorsNULL_ARGUMENT addressQuery or addressSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED addressQuery or addressSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAddressQueryFromInspector
Description

Gets an address query from an inspector. The inspector is available from an AddressSearchResults.

Parametersosid.contact.AddressQueryInspectoraddressQueryInspectoran address query inspector
Returnosid.contact.AddressQuerythe address book query
ErrorsNULL_ARGUMENT addressQueryInspector is null
UNSUPPORTED addressQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.