Interface | osid.installation.DepotSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getDepots | ||
Description |
Gets the depot list resulting from the search. | ||
Return | osid.installation.DepotList | the depot list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getDepotQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.installation.DepotQueryInspector | the depot query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getDepotSearchResultsRecord | ||
Description |
Gets the depot search results record corresponding to
the given depot search record | ||
Parameters | osid.type.Type | depotSearchRecordType | a depot search record type |
Return | osid.installation.records.DepotSearchResultsRecord | the depot search results record | |
Errors | NULL_ARGUMENT | depotSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(depotSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |