Interface | osid.billing.PeriodSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getPeriods | ||
Description |
Gets the period list resulting from a search. | ||
Return | osid.billing.PeriodList | the period list | |
Errors | ILLEGAL_STATE | the period list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getPeriodQueryInspector | ||
Description |
Gets the inspector for the query to examine the periods used in the search. | ||
Return | osid.billing.PeriodQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getPeriodSearchResultsRecord | ||
Description |
Gets the period search results record corresponding to
the given period search record | ||
Parameters | osid.type.Type | periodSearchRecordType | a period search record type |
Return | osid.billing.records.PeriodSearchResultsRecord | the period search results record | |
Errors | NULL_ARGUMENT | periodSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(periodSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |