Interface RequestTransactionSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, RequestTransactionQuerySession

public interface RequestTransactionSearchSession
extends RequestTransactionQuerySession

This session provides methods for searching among RequestTransaction objects. The search query is constructed using the RequestTransactionQuery .

getRequestTransactionsByQuery() is the basic search method and returns a list of RequestTransactions . A more advanced search may be performed with getRequestTransactionsBySearch() . It accepts a RequestTransactionSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRequestTransactionsBySearch() returns a RequestTransactionSearchResults that can be used to access the resulting RequestTransactionList or be used to perform a search within the result set through RequestTransactionSearch .

Method Summary

Modifier and Type	Method	Description
RequestTransactionQuery	getRequestTransactionQueryFromInspector(RequestTransactionQueryInspector requestTransactionQueryInspector)	Gets a request transaction query from an inspector.
RequestTransactionSearchResults	getRequestTransactionsBySearch(RequestTransactionQuery requestTransactionQuery, RequestTransactionSearch requestTransactionSearch)	Gets the search results matching the given search query using the given search.
RequestTransactionSearch	getRequestTransactionSearch()	Gets a request transaction search.
RequestTransactionSearchOrder	getRequestTransactionSearchOrder()	Gets a request transaction 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 RequestTransactionQuerySession

canSearchRequestTransactions, getDistributor, getDistributorId, getRequestTransactionQuery, getRequestTransactionsByQuery, useFederatedDistributorView, useIsolatedDistributorView

Modifier and Type	Method	Description
boolean	canSearchRequestTransactions()	Tests if this user can perform RequestTransaction lookups.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
RequestTransactionQuery	getRequestTransactionQuery()	Gets a request transaction query.
RequestTransactionList	getRequestTransactionsByQuery(RequestTransactionQuery requestTransactionQuery)	Gets a list of RequestTransactions matching the given request transaction query.
void	useFederatedDistributorView()	Federates the view for methods in this session.
void	useIsolatedDistributorView()	Isolates the view for methods in this session.

Method Details

getRequestTransactionSearch

RequestTransactionSearch getRequestTransactionSearch()

Gets a request transaction search.

Returns:

the request transaction search

Compliance:

mandatory - This method must be implemented.

getRequestTransactionSearchOrder

RequestTransactionSearchOrder getRequestTransactionSearchOrder()

Gets a request transaction search order. The RequestTransactionSearchOrder is supplied to a RequestTransactionSearch to specify the ordering of results.

Returns:

the request transaction search order

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsBySearch

RequestTransactionSearchResults getRequestTransactionsBySearch(RequestTransactionQuery requestTransactionQuery,
 RequestTransactionSearch requestTransactionSearch)
                                                        throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

requestTransactionQuery - the request transaction query

requestTransactionSearch - the request transaction search

Returns:

the request transaction search results

Throws:

NullArgumentException - requestTransactionQuery or requestTransactionSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - requestTransactionQuery or requestTransactionSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRequestTransactionQueryFromInspector

RequestTransactionQuery getRequestTransactionQueryFromInspector(RequestTransactionQueryInspector requestTransactionQueryInspector)

Gets a request transaction query from an inspector. The inspector is available from a RequestTransactionSearchResults .

Parameters:

requestTransactionQueryInspector - a request transaction query inspector

Returns:

the request transaction query

Throws:

NullArgumentException - requestTransactionQueryInspector is null

UnsupportedException - requestTransactionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.