Interface FoundrySearchSession

All Superinterfaces:

AutoCloseable, Closeable, FoundryQuerySession, OsidSession, OsidSession

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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface FoundryQuerySession

canSearchFoundries, getFoundriesByQuery, getFoundryQuery

Modifier and Type	Method	Description
boolean	canSearchFoundries()	Tests if this user can perform Foundry searches.
FoundryList	getFoundriesByQuery(FoundryQuery foundryQuery)	Gets a list of Foundries matching the given foundry query.
FoundryQuery	getFoundryQuery()	Gets a foundry query.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getFoundrySearch

FoundrySearch getFoundrySearch()

Gets a foundry search.

Returns:

the foundry search

Compliance:

mandatory - This method must be implemented.

getFoundrySearchOrder

FoundrySearchOrder getFoundrySearchOrder()

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

Returns:

the foundry search order

Compliance:

mandatory - This method must be implemented.

getFoundriesBySearch

FoundrySearchResults getFoundriesBySearch(FoundryQuery foundryQuery,
 FoundrySearch foundrySearch)
                                   throws OperationFailedException,
PermissionDeniedException

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

Parameters:

foundryQuery - the foundry query

foundrySearch - the foundry search

Returns:

the returned search results

Throws:

NullArgumentException - foundryQuery or foundrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - foundryQuery or foundrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getFoundryQueryFromInspector

FoundryQuery getFoundryQueryFromInspector(FoundryQueryInspector foundryQueryInspector)

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

Parameters:

foundryQueryInspector - a foundry query inspector

Returns:

the foundry query

Throws:

NullArgumentException - foundryQueryInspector is null

UnsupportedException - foundryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.