org.osid.billing

Interface CustomerSmartBusinessSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface CustomerSmartBusinessSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A CustomerQuery can be retrieved from this session and mapped to this Business to create a virtual collection of Customers. The customers may be sequenced using the CustomerSearchOrder from this session.

This Business has a default query that matches any customer and a default search order that specifies no sequencing. The queries may be examined using a CustomerQueryInspector. The query may be modified by converting the inspector back to a CustomerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCustomerQuery(CustomerQuery customerQuery) Applies a customer query to this business.
void	applyCustomerSequencing(CustomerSearchOrder customerSearchOrder) Applies a customer search order to this business.
boolean	canManageSmartBusinesses() Tests if this user can manage smart businesses.
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.
CustomerQuery	getCustomerQueryFromInspector(CustomerQueryInspector customerQueryInspector) Gets a customer query from an inspector.
CustomerSearchOrder	getCustomerSearchOrder() Gets a customer search order.
CustomerQueryInspector	inspectCustomerQuery() Gets a customer query inspector for this business.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBusinessId

Id getBusinessId()

Gets the Business Id associated with this session.

Returns:

the Business Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusiness

Business getBusiness()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Business associated with this session.

Returns:

the business

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartBusinesses

boolean canManageSmartBusinesses()

Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart business management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCustomerQuery

CustomerQuery getCustomerQuery()

Gets a customer query.

Returns:

the customer query

Compliance:

mandatory - This method must be implemented.

getCustomerSearchOrder

CustomerSearchOrder getCustomerSearchOrder()

Gets a customer search order.

Returns:

the customer search order

Compliance:

mandatory - This method must be implemented.

applyCustomerQuery

void applyCustomerQuery(CustomerQuery customerQuery)
                        throws OperationFailedException,
                               PermissionDeniedException

Applies a customer query to this business.

Parameters:

customerQuery - the customer query

Throws:

NullArgumentException - customerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - customerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCustomerQuery

CustomerQueryInspector inspectCustomerQuery()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets a customer query inspector for this business.

Returns:

the customer query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCustomerSequencing

void applyCustomerSequencing(CustomerSearchOrder customerSearchOrder)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a customer search order to this business.

Parameters:

customerSearchOrder - the customer search order

Throws:

NullArgumentException - customerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - customerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCustomerQueryFromInspector

CustomerQuery getCustomerQueryFromInspector(CustomerQueryInspector customerQueryInspector)

Gets a customer query from an inspector.

Parameters:

customerQueryInspector - a 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.