OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.PeriodSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByDisplayLabel
Description

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

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

Specified a preference for ordering results by the open date.

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

Specified a preference for ordering results by close date.

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

Specified a preference for ordering results by billing date.

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

Specifies a preference for ordering the result set by the due date.

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

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

Parametersosid.type.TypeperiodRecordTypea period record type
Returnosid.billing.records.PeriodSearchOrderRecordthe period search order record
ErrorsNULL_ARGUMENT periodRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(periodRecordType) is false
CompliancemandatoryThis method must be implemented.