OSID Logo
OSID Specifications
contact package
Version 3.1.0
Interfaceosid.contact.AddressSearchOrder
Implementsosid.OsidObjectSearchOrder
Used Byosid.contact.AddressSearchSession
osid.contact.AddressSmartAddressBookSession
osid.contact.ContactSearchOrder
osid.room.BuildingSearchOrder
osid.subscription.SubscriptionSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByResource
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsResourceSearchOrder
Description

Tests if a resource order is available.

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

Gets the resource order.

Returnosid.resource.ResourceSearchOrder the resource search order
ErrorsUNIMPLEMENTED supportsAddresseeSearchOrder() is false
Complianceoptional This 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.TypeaddressRecordType an address record type
Returnosid.contact.records.AddressSearchOrderRecord the address search order record
ErrorsNULL_ARGUMENT addressRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(addressRecordType) is false
Compliancemandatory This method must be implemented.