Interface | osid.financials.posting.PostSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getPosts | ||
Description |
Gets the post list resulting from a search. | ||
Return | osid.financials.posting.PostList | the post list | |
Errors | ILLEGAL_STATE | the post list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getPostQueryInspector | ||
Description |
Gets the inspector for the query to examine the periods used in the search. | ||
Return | osid.financials.posting.PostQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getPostSearchResultsRecord | ||
Description |
Gets the post search results record corresponding to
the given post search record | ||
Parameters | osid.type.Type | postSearchRecordType | a post search record type |
Return | osid.financials.posting.records.PostSearchResultsRecord | the post search results record | |
Errors | NULL_ARGUMENT | postSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(postSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |