OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.SubscriptionSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByDispatch
Description

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

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

Tests if a dispatch order is available.

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

Gets the dispatch order.

Returnosid.subscription.DispatchSearchOrderthe dispatch search order
ErrorsUNIMPLEMENTED supportsDispatchSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsDispatchSearchOrder() is true.
MethodorderBySubscriber
Description

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

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

Tests if a subscriber order is available.

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

Gets the subscriber order.

Returnosid.resource.ResourceSearchOrderthe subscriber search order
ErrorsUNIMPLEMENTED supportsSubscriberSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsSubscriberSearchOrder() is true.
MethodorderByAddress
Description

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

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

Tests if a address order is available.

Returnboolean true if an address order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAddressSearchOrder
Description

Gets the address order.

Returnosid.contact.AddressSearchOrderthe address search order
ErrorsUNIMPLEMENTED supportsAddressSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAddressSearchOrder() is true.
MethodgetSubscriptionSearchOrderRecord
Description

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

Parametersosid.type.TypesubscriptionRecordTypea subscription record type
Returnosid.subscription.records.SubscriptionSearchOrderRecordthe subscription search order record
ErrorsNULL_ARGUMENT subscriptionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subscriptionRecordType) is false
CompliancemandatoryThis method must be implemented.