Interface | osid.billing.PeriodSearchSession | ||
---|---|---|---|
Implements | osid.billing.PeriodQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Periods may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getPeriodSearch | ||
Description |
Gets a period search. | ||
Return | osid.billing.PeriodSearch | the period search | |
Compliance | mandatory | This method must be implemented. | |
Method | getPeriodSearchOrder | ||
Description |
Gets a period search order. The | ||
Return | osid.billing.PeriodSearchOrder | the period search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getPeriodsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.billing.PeriodQuery | periodQuery | the period query |
osid.billing.PeriodSearch | periodSearch | the period search | |
Return | osid.billing.PeriodSearchResults | the period search results | |
Errors | NULL_ARGUMENT | periodQuery or periodSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | periodQuery or periodSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPeriodQueryFromInspector | ||
Description |
Gets a period query from an inspector. The inspector is
available from a | ||
Parameters | osid.billing.PeriodQueryInspector | periodQueryInspector | a period query inspector |
Return | osid.billing.PeriodQuery | the period query | |
Errors | NULL_ARGUMENT | periodQueryInspector is null | |
UNSUPPORTED | periodQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |