| Interface | osid.billing.PeriodSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description | 
                 The search interface for governing period searches.  | ||
| Method | searchAmongPeriods | ||
| Description | 
                     Execute this search among the given list of periods.  | ||
| Parameters | osid.id.IdList | periodIds | list of periods | 
| Errors | NULL_ARGUMENT |  periodIds  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderPeriodResults | ||
| Description | 
                     Specify an ordering to the search results.  | ||
| Parameters | osid.billing.PeriodSearchOrder | periodSearchOrder | period search order | 
| Errors | NULL_ARGUMENT |  periodSearchOrder  is  null   |                 |
| UNSUPPORTED |  periodSearchOrder  is not of this service  |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPeriodSearchRecord | ||
| Description | 
                     Gets the period search record corresponding to the 
                    given period search record   | ||
| Parameters | osid.type.Type | periodSearchRecordType | a period search record type | 
| Return | osid.billing.records.PeriodSearchRecord | the period search 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. | |