OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.PeriodSearchResults
Implementsosid.OsidSearchResults
Used Byosid.billing.PeriodSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetPeriods
Description

Gets the period list resulting from a search.

Returnosid.billing.PeriodList the period list
ErrorsILLEGAL_STATE the period list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetPeriodQueryInspector
Description

Gets the inspector for the query to examine the periods used in the search.

Returnosid.billing.PeriodQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetPeriodSearchResultsRecord
Description

Gets the period search results 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.PeriodSearchResultsRecord the period search results record
ErrorsNULL_ARGUMENT periodSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(periodSearchRecordType) is false
Compliancemandatory This method must be implemented.