Interface ConferralSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ConferralQuerySession, OsidSession, OsidSession

public interface ConferralSearchSession
extends ConferralQuerySession

This session provides methods for searching Conferrals . The search query is constructed using the ConferralQuery . The conferral record Type also specifies the record for the conferral query.

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

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

Method Summary

Modifier and Type	Method	Description
ConferralQuery	getConferralQueryFromInspector(ConferralQueryInspector conferralQueryInspector)	Gets a conferral query from an inspector.
ConferralSearchResults	getConferralsBySearch(ConferralQuery conferralQuery, ConferralSearch conferralSearch)	Gets the search results matching the given search.
ConferralSearch	getConferralSearch()	Gets a conferral search.
ConferralSearchOrder	getConferralSearchOrder()	Gets a conferral search order.

Methods inherited from interface Closeable

close

Methods inherited from interface ConferralQuerySession

canSearchConferrals, getAcademy, getAcademyId, getConferralQuery, getConferralsByQuery, useFederatedAcademyView, useIsolatedAcademyView

Modifier and Type	Method	Description
boolean	canSearchConferrals()	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.
ConferralQuery	getConferralQuery()	Gets a conferral query.
ConferralList	getConferralsByQuery(ConferralQuery conferralQuery)	Gets a list of conferrals matching the given conferral 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

getConferralSearch

ConferralSearch getConferralSearch()

Gets a conferral search.

Returns:

the conferral search

Compliance:

mandatory - This method must be implemented.

getConferralSearchOrder

ConferralSearchOrder getConferralSearchOrder()

Gets a conferral search order. The ConferralSearchOrder is supplied to a ConferralSearch to specify the ordering of results.

Returns:

the conferral search order interface

Compliance:

mandatory - This method must be implemented.

getConferralsBySearch

ConferralSearchResults getConferralsBySearch(ConferralQuery conferralQuery,
 ConferralSearch conferralSearch)
                                      throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

conferralQuery - the conferral query

conferralSearch - the conferral search

Returns:

the conferral search results

Throws:

NullArgumentException - conferralQuery or conferralSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - conferralQuery or conferralSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getConferralQueryFromInspector

ConferralQuery getConferralQueryFromInspector(ConferralQueryInspector conferralQueryInspector)

Gets a conferral query from an inspector. The inspector is available from a ConferralSearchResults .

Parameters:

conferralQueryInspector - a conferral query inspector

Returns:

the conferral query

Throws:

NullArgumentException - conferralQueryInspector is null

UnsupportedException - conferralQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.