org.osid.subscription

Interface SubscriptionSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface SubscriptionSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AddressSearchOrder	getAddressSearchOrder() Gets the address order.
DispatchSearchOrder	getDispatchSearchOrder() Gets the dispatch order.
ResourceSearchOrder	getSubscriberSearchOrder() Gets the subscriber order.
SubscriptionSearchOrderRecord	getSubscriptionSearchOrderRecord(Type subscriptionRecordType) Gets the subscription search order record corresponding to the given subscription record Type.
void	orderByAddress(SearchOrderStyle style) Specifies a preference for ordering the result set by the address.
void	orderByDispatch(SearchOrderStyle style) Specifies a preference for ordering the result set by the dispatch.
void	orderBySubscriber(SearchOrderStyle style) Specifies a preference for ordering the result set by the subscriber.
boolean	supportsAddressSearchOrder() Tests if a address order is available.
boolean	supportsDispatchSearchOrder() Tests if a dispatch order is available.
boolean	supportsSubscriberSearchOrder() Tests if a subscriber order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByDispatch

void orderByDispatch(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsDispatchSearchOrder

boolean supportsDispatchSearchOrder()

Tests if a dispatch order is available.

Returns:

true if a dispatch order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDispatchSearchOrder

DispatchSearchOrder getDispatchSearchOrder()

Gets the dispatch order.

Returns:

the dispatch search order

Throws:

UnimplementedException - supportsDispatchSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsDispatchSearchOrder() is true.

orderBySubscriber

void orderBySubscriber(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSubscriberSearchOrder

boolean supportsSubscriberSearchOrder()

Tests if a subscriber order is available.

Returns:

true if a subscriber order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubscriberSearchOrder

ResourceSearchOrder getSubscriberSearchOrder()

Gets the subscriber order.

Returns:

the subscriber search order

Throws:

UnimplementedException - supportsSubscriberSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsSubscriberSearchOrder() is true.

orderByAddress

void orderByAddress(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAddressSearchOrder

boolean supportsAddressSearchOrder()

Tests if a address order is available.

Returns:

true if an address order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAddressSearchOrder

AddressSearchOrder getAddressSearchOrder()

Gets the address order.

Returns:

the address search order

Throws:

UnimplementedException - supportsAddressSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsAddressSearchOrder() is true.

getSubscriptionSearchOrderRecord

SubscriptionSearchOrderRecord getSubscriptionSearchOrderRecord(Type subscriptionRecordType)
                                                               throws OperationFailedException

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

Parameters:

subscriptionRecordType - a subscription record type

Returns:

the subscription search order record

Throws:

NullArgumentException - subscriptionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subscriptionRecordType) is false

Compliance:

mandatory - This method must be implemented.