Interface EntrySearchSession

All Superinterfaces:

AutoCloseable, Closeable, EntryQuerySession, OsidSession, OsidSession

public interface EntrySearchSession
extends EntryQuerySession

This session provides methods for searching among entries. The search query is constructed using the EntryQuery .

getEntryByQuery() is the basic search method and returns a list of Entries . A more advanced search may be performed with getEntriesBySearch() .It accepts an EntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEntriesBySearch() returns an EntrySearchResult that can be used to access the resulting EntryList or be used to perform a search within the result set through EntrySearch .

Method Summary

Modifier and Type	Method	Description
EntrySearchResults	getEntriesBySearch(EntryQuery entryQuery, EntrySearch entrySearch)	Gets a list of Entry elements matching the given search.
EntryQuery	getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)	Gets an entry query from an inspector.
EntrySearch	getEntrySearch()	Gets an entry search.
EntrySearchOrder	getEntrySearchOrder()	Gets an entry search order.

Methods inherited from interface Closeable

close

Methods inherited from interface EntryQuerySession

canSearchEntries, getDictionary, getDictionaryId, getEntriesByQuery, getEntryQuery, useFederatedDictionaryView, useIsolatedDictionaryView

Modifier and Type	Method	Description
boolean	canSearchEntries()	Tests if this user can perform dictionary entry searches.
Dictionary	getDictionary()	Gets the Dictionary associated with this session.
Id	getDictionaryId()	Gets the Dictionary Id associated with this session.
EntryList	getEntriesByQuery(EntryQuery entryQuery)	Gets a list of Entry elements matching the given search.
EntryQuery	getEntryQuery()	Gets an entry query.
void	useFederatedDictionaryView()	Federates the view for methods in this session.
void	useIsolatedDictionaryView()	Isolates the view for methods in this session.

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

getEntrySearch

EntrySearch getEntrySearch()

Gets an entry search.

Returns:

the entry search

Compliance:

mandatory - This method must be implemented.

getEntrySearchOrder

EntrySearchOrder getEntrySearchOrder()

Gets an entry search order. The EntrySearchOrder is supplied to an EntrySearch to specify the ordering of results.

Returns:

the entry search order

Compliance:

mandatory - This method must be implemented.

getEntriesBySearch

EntrySearchResults getEntriesBySearch(EntryQuery entryQuery,
 EntrySearch entrySearch)
                               throws OperationFailedException,
PermissionDeniedException

Gets a list of Entry elements matching the given search.

Parameters:

entryQuery - the entry query

entrySearch - the entry search

Returns:

the returned search results

Throws:

NullArgumentException - entryQuery or entrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - entrySearch or entryQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getEntryQueryFromInspector

EntryQuery getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)

Gets an entry query from an inspector. The inspector is available from an EntrySearchResults .

Parameters:

entryQueryInspector - an entry query inspector

Returns:

the entry query

Throws:

NullArgumentException - entryQueryInspector is null

UnsupportedException - entryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.