OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByResource
Description

Specifies a preference for ordering the result set by the resource.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsResourceSearchOrder
Description

Tests if a resource order is available.

Returnboolean true if a resource order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResourceSearchOrder
Description

Gets the resource order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsAddresseeSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAddresseeSearchOrder() is true.
MethodgetAddressSearchOrderRecord
Description

Gets the address search order record corresponding to the given address record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeaddressRecordTypean address record type
Returnosid.contact.records.AddressSearchOrderRecordthe address search order record
ErrorsNULL_ARGUMENT addressRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(addressRecordType) is false
CompliancemandatoryThis method must be implemented.