OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.PeriodSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetPeriods
Description

Gets the period list resulting from a search.

Returnosid.billing.PeriodListthe period list
ErrorsILLEGAL_STATEthe period list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPeriodQueryInspector
Description

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

Returnosid.billing.PeriodQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypeperiodSearchRecordTypea period search record type
Returnosid.billing.records.PeriodSearchResultsRecordthe period search results record
ErrorsNULL_ARGUMENT periodSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(periodSearchRecordType) is false
CompliancemandatoryThis method must be implemented.