OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.FoundrySearchSession
Implementsosid.resourcing.FoundryQuerySession
Description

This session provides methods for searching among Foundry objects. The search query is constructed using the FoundryQuery.

getFoundriesByQuery() is the basic search method and returns a list of Foundries. A more advanced search may be performed with getFoundriesBySearch(). It accepts a FoundrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getFoundriesBySearch() returns a FoundrySearchResults that can be used to access the resulting FoundryList or be used to perform a search within the result set through FoundrySearch.

Foundries may have a query record indicated by their respective record types. The query record is accessed via the FoundryQuery.

MethodgetFoundrySearch
Description

Gets a foundry search.

Returnosid.resourcing.FoundrySearchthe foundry search
CompliancemandatoryThis method must be implemented.
MethodgetFoundrySearchOrder
Description

Gets a foundry search order. The FoundrySearchOrder is supplied to a FoundrySearch to specify the ordering of results.

Returnosid.resourcing.FoundrySearchOrderthe foundry search order
CompliancemandatoryThis method must be implemented.
MethodgetFoundriesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.resourcing.FoundryQueryfoundryQuerythe foundry query
osid.resourcing.FoundrySearchfoundrySearchthe foundry search
Returnosid.resourcing.FoundrySearchResultsthe returned search results
ErrorsNULL_ARGUMENT foundryQuery or foundrySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED foundryQuery or foundrySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFoundryQueryFromInspector
Description

Gets a foundry query from an inspector. The inspector is available from a FoundrySearchResults.

Parametersosid.resourcing.FoundryQueryInspectorfoundryQueryInspectora foundry query inspector
Returnosid.resourcing.FoundryQuerythe foundry query
ErrorsNULL_ARGUMENT foundryQueryInspector is null
UNSUPPORTED foundryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.