OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.EntrySearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByCustomer
Description

Specifies a preference for ordering the result set by customer.

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

Tests if a customer search order is available.

Returnboolean true if a customer search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCustomerSearchOrder
Description

Gets the customer order.

Returnosid.billing.CustomerSearchOrderthe customer search order
ErrorsUNIMPLEMENTED supportsCustomerSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCustomerSearchOrder() is true.
MethodorderByItem
Description

Specifies a preference for ordering the result set by item.

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

Tests if an item search order is available.

Returnboolean true if an item search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemSearchOrder
Description

Gets the item search order.

Returnosid.billing.ItemSearchOrderthe item search order
ErrorsUNIMPLEMENTED supportsItemSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsItemSearchOrder() is true.
MethodorderByPeriod
Description

Specifies a preference for ordering the result set by billing period.

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

Tests if a billing period search order is available.

Returnboolean true if a term search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPeriodSearchOrder
Description

Gets the billing period search order.

Returnosid.billing.PeriodSearchOrderthe period search order
ErrorsUNIMPLEMENTED supportsPeriodSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsPeriodSearchOrder() is true.
MethodorderByQuantity
Description

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

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

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

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

Specifies a preference for ordering the result set by the debit flag.

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

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

Parametersosid.type.TypeentryRecordTypean entry record type
Returnosid.billing.records.EntrySearchOrderRecordthe entry search order record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.