Interface | osid.billing.EntrySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getEntries | ||
Description |
Gets the entry list resulting from a search. | ||
Return | osid.billing.EntryList | the entry list | |
Errors | ILLEGAL_STATE | the entry list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getEntryQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.billing.EntryQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getEntrySearchResultsRecord | ||
Description |
Gets the entry search results record corresponding to
the given entry search record | ||
Parameters | osid.type.Type | entrySearchRecordType | a entry search record type |
Return | osid.billing.records.EntrySearchResultsRecord | the entry search interface | |
Errors | NULL_ARGUMENT | entrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(entrySearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |