OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.CustomerSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidTemporalSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByResource
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodgetResourceSearchOrder
Description

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

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsResourceSearchOrder() is true.
MethodorderByCustomerNumber
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByActivity
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchOrder
Description

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

Returnosid.financials.ActivitySearchOrderthe activity search order
ErrorsUNIMPLEMENTED supportsActivitySearchOrder() is false
ComplianceoptionalThis 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.TypecustomerRecordTypea customer record type
Returnosid.billing.records.CustomerSearchOrderRecordthe customer search order record
ErrorsNULL_ARGUMENT customerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(customerRecordType) is false
CompliancemandatoryThis method must be implemented.