Interface CreditSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CreditQuerySession, OsidSession, OsidSession

public interface CreditSearchSession
extends CreditQuerySession

This session provides methods for searching Credit objects. The search query is constructed using the CreditQuery. The credit record Type also specifies the record for the credit query.

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

This session defines views that offer differing behaviors for searching.

• federated billing view: searches include credits in billings of which this billing is a ancestor in the billing hierarchy
• isolated billing view: searches are restricted to credits in this billing

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

Method Summary

Modifier and Type	Method	Description
CreditQuery	getCreditQueryFromInspector(CreditQueryInspector creditQueryInspector)	Gets a credit query from an inspector.
CreditSearchResults	getCreditsBySearch(CreditQuery creditQuery, CreditSearch creditSearch)	Gets the search results matching the given search.
CreditSearch	getCreditSearch()	Gets a credit search.
CreditSearchOrder	getCreditSearchOrder()	Gets a credit search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CreditQuerySession

canSearchCredits, getBilling, getBillingId, getCreditQuery, getCreditsByQuery, useFederatedBillingView, useIsolatedBillingView

Modifier and Type	Method	Description
boolean	canSearchCredits()	Tests if this user can perform Credit searches.
Billing	getBilling()	Gets the Billing associated with this session.
Id	getBillingId()	Gets the Billing Id associated with this session.
CreditQuery	getCreditQuery()	Gets a credit query.
CreditList	getCreditsByQuery(CreditQuery creditQuery)	Gets a list of credits matching the given credit query.
void	useFederatedBillingView()	Federates the view for methods in this session.
void	useIsolatedBillingView()	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

getCreditSearch

CreditSearch getCreditSearch()

Gets a credit search.

Returns:

the credit search

Compliance:

mandatory - This method must be implemented.

getCreditSearchOrder

CreditSearchOrder getCreditSearchOrder()

Gets a credit search order. The CreditSearchOrder is supplied to a CreditSearch to specify the ordering of results.

Returns:

the credit search order

Compliance:

mandatory - This method must be implemented.

getCreditsBySearch

CreditSearchResults getCreditsBySearch(CreditQuery creditQuery,
 CreditSearch creditSearch)
                                throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

creditQuery - the credit query

creditSearch - the credit search

Returns:

the search results

Throws:

NullArgumentException - creditQuery or creditSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - creditQuery or creditSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCreditQueryFromInspector

CreditQuery getCreditQueryFromInspector(CreditQueryInspector creditQueryInspector)

Gets a credit query from an inspector. The inspector is available from a CreditSearchResults.

Parameters:

creditQueryInspector - a credit query inspector

Returns:

the credit query

Throws:

NullArgumentException - creditQueryInspector is null

UnsupportedException - creditQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.