Interface CommissionSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CommissionQuerySession, OsidSession, OsidSession

public interface CommissionSearchSession
extends CommissionQuerySession

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

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

This session defines views that offer differing behaviors for searching.

• federated foundry view: searches include commissions in foundries of which this foundry is an ancestor in the foundry hierarchy
• isolated foundry view: searches are restricted to commissions in this foundry

Commissions may have a query record indicated by their respective record types. The query record is accessed via the CommissionQuery .

Method Summary

Modifier and Type	Method	Description
CommissionQuery	getCommissionQueryFromInspector(CommissionQueryInspector commissionQueryInspector)	Gets a commission query from an inspector.
CommissionSearchResults	getCommissionsBySearch(CommissionQuery commissionQuery, CommissionSearch commissionSearch)	Gets the search results matching the given search query using the given search.
CommissionSearch	getCommissionSearch()	Gets a commission search.
CommissionSearchOrder	getCommissionSearchOrder()	Gets a commission search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CommissionQuerySession

canSearchCommissions, getCommissionQuery, getCommissionsByQuery, getFoundry, getFoundryId, useFederatedFoundryView, useIsolatedFoundryView

Modifier and Type	Method	Description
boolean	canSearchCommissions()	Tests if this user can perform Commission lookups.
CommissionQuery	getCommissionQuery()	Gets a commission query.
CommissionList	getCommissionsByQuery(CommissionQuery commissionQuery)	Gets a list of Commissions matching the given commission query.
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
void	useFederatedFoundryView()	Federates the view for methods in this session.
void	useIsolatedFoundryView()	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

getCommissionSearch

CommissionSearch getCommissionSearch()

Gets a commission search.

Returns:

the commission search

Compliance:

mandatory - This method must be implemented.

getCommissionSearchOrder

CommissionSearchOrder getCommissionSearchOrder()

Gets a commission search order. The CommissionSearchOrder is supplied to a CommissionSearch to specify the ordering of results.

Returns:

the commission search order

Compliance:

mandatory - This method must be implemented.

getCommissionsBySearch

CommissionSearchResults getCommissionsBySearch(CommissionQuery commissionQuery,
 CommissionSearch commissionSearch)
                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

commissionQuery - the commission query

commissionSearch - the commission search

Returns:

the returned search results

Throws:

NullArgumentException - commissionQuery or commissionSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - commissionQuery or commissionSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCommissionQueryFromInspector

CommissionQuery getCommissionQueryFromInspector(CommissionQueryInspector commissionQueryInspector)

Gets a commission query from an inspector. The inspector is available from a CommissionSearchResults .

Parameters:

commissionQueryInspector - a commission query inspector

Returns:

the commission query

Throws:

NullArgumentException - commissionQueryInspector is null

UnsupportedException - commissionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.