| Interface | osid.financials.posting.PostEntrySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getPostEntries | ||
| Description |
Gets the post entry list resulting from a search. | ||
| Return | osid.financials.posting.PostEntryList | the post entry list | |
| Errors | ILLEGAL_STATE | the post entry list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostEntryQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.financials.posting.PostEntryQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostEntrySearchResultsRecord | ||
| Description |
Gets the post entry search results record corresponding
to the given post entry search record | ||
| Parameters | osid.type.Type | postEntrySearchRecordType | a post entry search record type |
| Return | osid.financials.posting.records.PostEntrySearchResultsRecord | the post entry search interface | |
| Errors | NULL_ARGUMENT | postEntrySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(postEntrySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |