org.osid.dictionary

Interface EntrySearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, EntryQuerySession, 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 a 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

Methods

Modifier and Type	Method and 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 org.osid.dictionary.EntryQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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 a 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.