org.osid.room.construction

Interface RenovationSearchSession

All Superinterfaces:

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

public interface RenovationSearchSession
extends RenovationQuerySession

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

Methods

Modifier and Type	Method and 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 org.osid.room.construction.RenovationQuerySession

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

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

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.