OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.PeriodSearch
Implementsosid.OsidSearch
Used Byosid.billing.PeriodSearchSession
Description

The search interface for governing period searches.

MethodsearchAmongPeriods
Description

Execute this search among the given list of periods.

Parametersosid.id.IdListperiodIds list of periods
ErrorsNULL_ARGUMENT periodIds is null
Compliancemandatory This method must be implemented.
MethodorderPeriodResults
Description

Specify an ordering to the search results.

Parametersosid.billing.PeriodSearchOrderperiodSearchOrder period search order
ErrorsNULL_ARGUMENT periodSearchOrder is null
UNSUPPORTED periodSearchOrder is not of this service
Compliancemandatory This 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.TypeperiodSearchRecordType a period search record type
Returnosid.billing.records.PeriodSearchRecord the period search record
ErrorsNULL_ARGUMENT periodSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(periodSearchRecordType) is false
Compliancemandatory This method must be implemented.