Interface CustomerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CustomerQuerySession, OsidSession, OsidSession

public interface CustomerSearchSession
extends CustomerQuerySession

This session provides methods for searching among Customers . The search query is constructed using the CustomerQuery .

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

This session defines views that offer differing behaviors for searching.

• federated business view: searches include customers in businesses of which this business is an ancestor in the business hierarchy
• isolated business view: searches are restricted to customers in this business

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

Method Summary

Modifier and Type	Method	Description
CustomerQuery	getCustomerQueryFromInspector(CustomerQueryInspector customerQueryInspector)	Gets a customer query from an inspector.
CustomerSearchResults	getCustomersBySearch(CustomerQuery customerQuery, CustomerSearch customerSearch)	Gets the search results matching the given search query using the given search.
CustomerSearch	getCustomerSearch()	Gets a customer search.
CustomerSearchOrder	getCustomerSearchOrder()	Gets a customer search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CustomerQuerySession

canSearchCustomers, getBusiness, getBusinessId, getCustomerQuery, getCustomersByQuery, useFederatedBusinessView, useIsolatedBusinessView

Modifier and Type	Method	Description
boolean	canSearchCustomers()	Tests if this user can perform Customer searches.
Business	getBusiness()	Gets the Business associated with this session.
Id	getBusinessId()	Gets the Business Id associated with this session.
CustomerQuery	getCustomerQuery()	Gets a customer query.
CustomerList	getCustomersByQuery(CustomerQuery customerQuery)	Gets a list of Customers matching the given customer query.
void	useFederatedBusinessView()	Federates the view for methods in this session.
void	useIsolatedBusinessView()	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

getCustomerSearch

CustomerSearch getCustomerSearch()

Gets a customer search.

Returns:

the customer search

Compliance:

mandatory - This method must be implemented.

getCustomerSearchOrder

CustomerSearchOrder getCustomerSearchOrder()

Gets a customer search order. The CustomerSearchOrder is supplied to a CustomerSearch to specify the ordering of results.

Returns:

the customer search order

Compliance:

mandatory - This method must be implemented.

getCustomersBySearch

CustomerSearchResults getCustomersBySearch(CustomerQuery customerQuery,
 CustomerSearch customerSearch)
                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

customerQuery - the customer query

customerSearch - the customer search

Returns:

the customer search results

Throws:

NullArgumentException - customerQuery or customerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - customerQuery or customerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCustomerQueryFromInspector

CustomerQuery getCustomerQueryFromInspector(CustomerQueryInspector customerQueryInspector)

Gets a customer query from an inspector. The inspector is available from a CustomerSearchResults .

Parameters:

customerQueryInspector - a customer query inspector

Returns:

the customer query

Throws:

NullArgumentException - customerQueryInspector is null

UnsupportedException - customerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.