org.osid.rules.check

Interface AgendaSearchSession

All Superinterfaces:

AgendaQuerySession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AgendaSearchSession
extends AgendaQuerySession

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

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

This session defines views that offer differing behaviors for searching.

• federated engine view: searches include agendas in engines of which this engine is an ancestor in the engine hierarchy
• isolated engine view: searches are restricted to agendas in this engine

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

Method Summary

Methods

Modifier and Type	Method and Description
AgendaQuery	getAgendaQueryFromInspector(AgendaQueryInspector agendaQueryInspector) Gets an agenda query from an inspector.
AgendaSearchResults	getAgendasBySearch(AgendaQuery agendaQuery, AgendaSearch agendaSearch) Gets the search results matching the given search query using the given search.
AgendaSearch	getAgendaSearch() Gets an agenda search.
AgendaSearchOrder	getAgendaSearchOrder() Gets an agenda search order.

Methods inherited from interface org.osid.rules.check.AgendaQuerySession

canSearchAgendas, getAgendaQuery, getAgendasByQuery, getEngine, getEngineId, useFederatedEngineView, useIsolatedEngineView

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

getAgendaSearch

AgendaSearch getAgendaSearch()

Gets an agenda search.

Returns:

the agenda search

Compliance:

mandatory - This method must be implemented.

getAgendaSearchOrder

AgendaSearchOrder getAgendaSearchOrder()

Gets an agenda search order. The AgendaSearchOrder is supplied to an AgendaSearch to specify the ordering of results.

Returns:

the agenda search order

Compliance:

mandatory - This method must be implemented.

getAgendasBySearch

AgendaSearchResults getAgendasBySearch(AgendaQuery agendaQuery,
                                     AgendaSearch agendaSearch)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

agendaQuery - the agenda query

agendaSearch - the agenda search

Returns:

the agenda search results

Throws:

NullArgumentException - agendaQuery or agendaSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - agendaQuery or agendaSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAgendaQueryFromInspector

AgendaQuery getAgendaQueryFromInspector(AgendaQueryInspector agendaQueryInspector)

Gets an agenda query from an inspector. The inspector is available from an AgendaSearchResults.

Parameters:

agendaQueryInspector - an agenda query inspector

Returns:

the agenda query

Throws:

NullArgumentException - agendaQueryInspector is null

UnsupportedException - agendaQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.