org.osid.billing

Interface CustomerSearchOrder

All Superinterfaces:

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

public interface CustomerSearchOrder
extends OsidObjectSearchOrder, OsidTemporalSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ActivitySearchOrder	getActivitySearchOrder() Specifies a preference for ordering the result set by the activity,
CustomerSearchOrderRecord	getCustomerSearchOrderRecord(Type customerRecordType) Gets the customer search order record corresponding to the given customer record Type.
ResourceSearchOrder	getResourceSearchOrder() Specifies a preference for ordering the result set by the resource.
void	orderByActivity(SearchOrderStyle style) Specifies a preference for ordering the result set by the activity.
void	orderByCustomerNumber(SearchOrderStyle style) Specifies a preference for ordering the result set by the customer number.
void	orderByResource(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
boolean	supportsActivitySearchOrder() Tests if an activity search order is available.
boolean	supportsResourceSearchOrder() Tests if a resource search order is available.

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

orderByResource

void orderByResource(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a resource search order is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

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

Returns:

the resource search order

Throws:

UnimplementedException - supportsResourceSearchOrder() is false

Compliance:

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

orderByCustomerNumber

void orderByCustomerNumber(SearchOrderStyle style)

Specifies a preference for ordering the result set by the customer number.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByActivity

void orderByActivity(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsActivitySearchOrder

boolean supportsActivitySearchOrder()

Tests if an activity search order is available.

Returns:

true if an activity search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivitySearchOrder

ActivitySearchOrder getActivitySearchOrder()

Specifies a preference for ordering the result set by the activity,

Returns:

the activity search order

Throws:

UnimplementedException - supportsActivitySearchOrder() is false

Compliance:

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

getCustomerSearchOrderRecord

CustomerSearchOrderRecord getCustomerSearchOrderRecord(Type customerRecordType)
                                                       throws OperationFailedException

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

Parameters:

customerRecordType - a customer record type

Returns:

the customer search order record

Throws:

NullArgumentException - customerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(customerRecordType) is false

Compliance:

mandatory - This method must be implemented.