org.osid.recognition

Interface ConvocationSearchSession

All Superinterfaces:

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

public interface ConvocationSearchSession
extends ConvocationQuerySession

This session provides methods for searching Convocation objects. The search query is constructed using the ConvocationQuery. The convocation record Type also specifies the record for the convocation query.

getConvocationsByQuery() is the basic search method and returns a list of Academy elements. A more advanced search may be performed with getConvocationsBySearch(). It accepts a ConvocationSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getConvocationsBySearch() returns a ConvocationSearchResults that can be used to access the resulting ConvocationList or be used to perform a search within the result set through ConvocationSearch.

Convocations may have a query record indicated by their respective record types. The query record is accessed via the ConvocationQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
ConvocationQuery	getConvocationQueryFromInspector(ConvocationQueryInspector convocationQueryInspector) Gets a convocation query from an inspector.
ConvocationSearchResults	getConvocationsBySearch(ConvocationQuery convocationQuery, ConvocationSearch convocationSearch) Gets the search results matching the given search.
ConvocationSearch	getConvocationSearch() Gets a convocation search.
ConvocationSearchOrder	getConvocationSearchOrder() Gets a convocation search order.

Methods inherited from interface org.osid.recognition.ConvocationQuerySession

canSearchConvocations, getAcademy, getAcademyId, getConvocationQuery, getConvocationsByQuery, useFederatedAcademyView, useIsolatedAcademyView

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

getConvocationSearch

ConvocationSearch getConvocationSearch()

Gets a convocation search.

Returns:

the convocation search

Compliance:

mandatory - This method must be implemented.

getConvocationSearchOrder

ConvocationSearchOrder getConvocationSearchOrder()

Gets a convocation search order. The ConvocationSearchOrder is supplied to a ConvocationSearch to specify the ordering of results.

Returns:

the convocation search order interface

Compliance:

mandatory - This method must be implemented.

getConvocationsBySearch

ConvocationSearchResults getConvocationsBySearch(ConvocationQuery convocationQuery,
                                               ConvocationSearch convocationSearch)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets the search results matching the given search.

Parameters:

convocationQuery - the convocation query

convocationSearch - the convocation search

Returns:

the convocation search results

Throws:

NullArgumentException - convocationQuery or convocationSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - convocationQuery or convocationSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getConvocationQueryFromInspector

ConvocationQuery getConvocationQueryFromInspector(ConvocationQueryInspector convocationQueryInspector)

Gets a convocation query from an inspector. The inspector is available from an ConvocationSearchResults.

Parameters:

convocationQueryInspector - a convocation query inspector

Returns:

the convocation query

Throws:

NullArgumentException - convocationQueryInspector is null

UnsupportedException - convocationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.