Interface RenovationSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, RenovationQuerySession

public interface RenovationSearchSession
extends RenovationQuerySession

This session provides methods for searching Renovations. The search query is constructed using the RenovationQuery. The renovation record Type also specifies the record for the renovation query.

getRenovationsByQuery() is the basic search method and returns a list of Renovation elements. A more advanced search may be performed with getRenovationsBySearch(). It accepts a RenovationSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRenovationeBySearch() returns a RenovationSearchResults that can be used to access the resulting RenovationList or be used to perform a search within the result set through RenovationSearch.

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

Method Summary

Modifier and Type	Method	Description
RenovationQuery	getRenovationQueryFromInspector(RenovationQueryInspector renovationQueryInspector)	Gets an entry query from an inspector.
RenovationSearchResults	getRenovationsBySearch(RenovationQuery renovationQuery, RenovationSearch renovationSearch)	Gets the search results matching the given search.
RenovationSearch	getRenovationSearch()	Gets a renovation search.
RenovationSearchOrder	getRenovationSearchOrder()	Gets a renovation search order.

Methods inherited from interface Closeable

close

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.

Methods inherited from interface RenovationQuerySession

canSearchRenovations, getCampus, getCampusId, getRenovationQuery, getRenovationsByQuery, useFederatedCampusView, useIsolatedCampusView

Modifier and Type	Method	Description
boolean	canSearchRenovations()	Tests if this user can perform Renovation searches.
Campus	getCampus()	Gets the Campus associated with this session.
Id	getCampusId()	Gets the Campus Id associated with this session.
RenovationQuery	getRenovationQuery()	Gets a renovation query.
RenovationList	getRenovationsByQuery(RenovationQuery renovationQuery)	Gets a list of Renovations matching the given renovation query.
void	useFederatedCampusView()	Federates the view for methods in this session.
void	useIsolatedCampusView()	Isolates the view for methods in this session.

Method Details

getRenovationSearch

RenovationSearch getRenovationSearch()

Gets a renovation search.

Returns:

the renovation search

Compliance:

mandatory - This method must be implemented.

getRenovationSearchOrder

RenovationSearchOrder getRenovationSearchOrder()

Gets a renovation search order. The RenovationSearchOrder is supplied to a RenovationSearch to specify the ordering of results.

Returns:

the renovation search order

Compliance:

mandatory - This method must be implemented.

getRenovationsBySearch

RenovationSearchResults getRenovationsBySearch(RenovationQuery renovationQuery,
 RenovationSearch renovationSearch)
                                        throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

renovationQuery - the renovation query

renovationSearch - the renovation search

Returns:

the renovation search results

Throws:

NullArgumentException - renovationQuery or renovationSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - renovationQuery or renovationSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRenovationQueryFromInspector

RenovationQuery getRenovationQueryFromInspector(RenovationQueryInspector renovationQueryInspector)

Gets an entry query from an inspector. The inspector is available from an RenovationSearchResults.

Parameters:

renovationQueryInspector - a query inspector

Returns:

the entry query

Throws:

NullArgumentException - renovationQueryInspector is null

UnsupportedException - renovationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.