public interface FoundrySearchSession extends FoundryQuerySession
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.
Modifier and Type | Method and Description |
---|---|
FoundrySearchResults |
getFoundriesBySearch(FoundryQuery foundryQuery,
FoundrySearch foundrySearch)
Gets the search results matching the given search query using the
given search.
|
FoundryQuery |
getFoundryQueryFromInspector(FoundryQueryInspector foundryQueryInspector)
Gets a foundry query from an inspector.
|
FoundrySearch |
getFoundrySearch()
Gets a foundry search.
|
FoundrySearchOrder |
getFoundrySearchOrder()
Gets a foundry search order.
|
canSearchFoundries, getFoundriesByQuery, getFoundryQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
FoundrySearch getFoundrySearch()
mandatory
- This method must be implemented. FoundrySearchOrder getFoundrySearchOrder()
FoundrySearchOrder
is
supplied to a FoundrySearch
to specify the ordering of
results.mandatory
- This method must be implemented. FoundrySearchResults getFoundriesBySearch(FoundryQuery foundryQuery, FoundrySearch foundrySearch) throws OperationFailedException, PermissionDeniedException
foundryQuery
- the foundry queryfoundrySearch
- the foundry searchNullArgumentException
- foundryQuery
or
foundrySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- foundryQuery
or
foundrySearch
is not of this servicemandatory
- This method must be implemented. FoundryQuery getFoundryQueryFromInspector(FoundryQueryInspector foundryQueryInspector)
FoundrySearchResults.
foundryQueryInspector
- a foundry query inspectorNullArgumentException
- foundryQueryInspector
is null
UnsupportedException
- foundryQueryInspector
is not of this servicemandatory
- This method must be implemented.