Interface ConvocationSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ConvocationQuerySession, OsidSession, OsidSession

public interface ConvocationSearchSession
extends ConvocationQuerySession

This session provides methods for searching Convocations. 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

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

close

Methods inherited from interface ConvocationQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchConvocations()	Tests if this user can perform susbcription searches.
Academy	getAcademy()	Gets the Academy associated with this session.
Id	getAcademyId()	Gets the Academy Id associated with this session.
ConvocationQuery	getConvocationQuery()	Gets a convocation query.
ConvocationList	getConvocationsByQuery(ConvocationQuery convocationQuery)	Gets a list of convocations matching the given convocation query.
void	useFederatedAcademyView()	Federates the view for methods in this session.
void	useIsolatedAcademyView()	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

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.