Interface BillingSearchSession

All Superinterfaces:

AutoCloseable, BillingQuerySession, Closeable, OsidSession, OsidSession

public interface BillingSearchSession
extends BillingQuerySession

This session provides methods for searching Billing objects. The search query is constructed using the BillingQuery. The billing record Type also specifies the billing query record for the billing query.

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

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

Method Summary

Modifier and Type	Method	Description
BillingQuery	getBillingQueryFromInspector(BillingQueryInspector billingQueryInspector)	Gets a billing query from an inspector.
BillingSearchResults	getBillingsBySearch(BillingQuery billingQuery, BillingSearch billingSearch)	Gets the search results matching the given search.
BillingSearch	getBillingSearch()	Gets a billing search.
BillingSearchOrder	getBillingSearchOrder()	Gets a billing search order.

Methods inherited from interface BillingQuerySession

canSearchBillings, getBillingQuery, getBillingsByQuery

Modifier and Type	Method	Description
boolean	canSearchBillings()	Tests if this user can perform Billing searches.
BillingQuery	getBillingQuery()	Gets a billing query.
BillingList	getBillingsByQuery(BillingQuery billingQuery)	Gets a list of Billings matching the given search.

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.

Method Details

getBillingSearch

BillingSearch getBillingSearch()

Gets a billing search.

Returns:

the billing search

Compliance:

mandatory - This method must be implemented.

getBillingSearchOrder

BillingSearchOrder getBillingSearchOrder()

Gets a billing search order. The BillingSearchOrder is supplied to a BillingSearch to specify the ordering of results.

Returns:

the billing search order

Compliance:

mandatory - This method must be implemented.

getBillingsBySearch

BillingSearchResults getBillingsBySearch(BillingQuery billingQuery,
 BillingSearch billingSearch)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

billingQuery - the billing query

billingSearch - the billing search

Returns:

the search results

Throws:

NullArgumentException - billingQuery or billingSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - billingQuery or billingSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBillingQueryFromInspector

BillingQuery getBillingQueryFromInspector(BillingQueryInspector billingQueryInspector)

Gets a billing query from an inspector. The inspector is available from a BillingSearchResults.

Parameters:

billingQueryInspector - a billing query inspector

Returns:

the billing query

Throws:

NullArgumentException - billingQueryInspector is null

UnsupportedException - ibillingQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.