OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.CustomerSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidTemporalSearchOrder
Used Byosid.billing.CustomerSearchSession
osid.billing.CustomerSmartBusinessSession
osid.billing.EntrySearchOrder
osid.billing.payment.PayerSearchOrder
osid.billing.payment.PaymentSearchOrder
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 a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsResourceSearchOrder
Description

Tests if a resource search order is available.

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

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

Returnosid.resource.ResourceSearchOrder the resource search order
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
Complianceoptional This method must be implemented if supportsResourceSearchOrder() is true.
MethodorderByCustomerNumber
Description

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

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

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

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

Tests if an activity search order is available.

Returnboolean true if an activity search order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetActivitySearchOrder
Description

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

Returnosid.financials.ActivitySearchOrder the activity search order
ErrorsUNIMPLEMENTED supportsActivitySearchOrder() is false
Complianceoptional This method must be implemented if supportsActivitySearchOrder() is true.
MethodgetCustomerSearchOrderRecord
Description

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

Parametersosid.type.TypecustomerRecordType a customer record type
Returnosid.billing.records.CustomerSearchOrderRecord the customer search order record
ErrorsNULL_ARGUMENT customerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(customerRecordType) is false
Compliancemandatory This method must be implemented.