OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.PeriodSearch
Implementsosid.OsidSearch
Description

The search interface for governing period searches.

MethodsearchAmongPeriods
Description

Execute this search among the given list of periods.

Parametersosid.id.IdListperiodIdslist of periods
ErrorsNULL_ARGUMENT periodIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPeriodResults
Description

Specify an ordering to the search results.

Parametersosid.billing.PeriodSearchOrderperiodSearchOrderperiod search order
ErrorsNULL_ARGUMENT periodSearchOrder is null
UNSUPPORTED periodSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPeriodSearchRecord
Description

Gets the period search record corresponding to the given period search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeperiodSearchRecordTypea period search record type
Returnosid.billing.records.PeriodSearchRecordthe period search record
ErrorsNULL_ARGUMENT periodSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(periodSearchRecordType) is false
CompliancemandatoryThis method must be implemented.