Interface | osid.resourcing.FoundrySearchSession | ||
---|---|---|---|
Implements | osid.resourcing.FoundryQuerySession | ||
Description |
This session provides methods for searching among Foundries may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getFoundrySearch | ||
Description |
Gets a foundry search. | ||
Return | osid.resourcing.FoundrySearch | the foundry search | |
Compliance | mandatory | This method must be implemented. | |
Method | getFoundrySearchOrder | ||
Description |
Gets a foundry search order. The | ||
Return | osid.resourcing.FoundrySearchOrder | the foundry search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getFoundriesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.resourcing.FoundryQuery | foundryQuery | the foundry query |
osid.resourcing.FoundrySearch | foundrySearch | the foundry search | |
Return | osid.resourcing.FoundrySearchResults | the returned search results | |
Errors | NULL_ARGUMENT | foundryQuery or foundrySearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | foundryQuery or foundrySearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFoundryQueryFromInspector | ||
Description |
Gets a foundry query from an inspector. The inspector
is available from a | ||
Parameters | osid.resourcing.FoundryQueryInspector | foundryQueryInspector | a foundry query inspector |
Return | osid.resourcing.FoundryQuery | the foundry query | |
Errors | NULL_ARGUMENT | foundryQueryInspector is null | |
UNSUPPORTED | foundryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |