Package com.apptus.esales.connector

Class Session

java.lang.Object

com.apptus.esales.connector.Session

public class Session
extends Object

A session where information is exchanged with an eSales service.

Use the notification methods to notify the eSales service about client-side activities. These notification will be used to improve results from eSales with the use of machine learning algorithms, and for statistical reports.
A tutorial section describing the procedure for notifying client-side activities can be found in the tutorial section Notifying Customer Actions on Apptus Zone (http://zone.apptus.com).

Use the panel(String) method to get a Panel object, from which you may retrieve content from the eSales service.

You may (but need not) call the end() method once the session is over. This will allow the eSales service to include the information in statistical reports. If you don't call end the session will end automatically on the eSales server after two hours.

Method Summary

Modifier and Type	Method	Description
String	customerKey()
DynamicPage	dynamicPage(String name)	Creates a dynamic page with the specified name.
boolean	end()	Notifies the eSales service that the session has ended.
String	key()
String	market()
void	notifyAddingToCart(String ticketEnc)	Sends a notification to the eSales service, about a product being added to the shopping cart by a user in the session.
void	notifyClick(String ticketEnc)	Sends a notification to the eSales service, about a click being made by the user in a session.
void	notifyFavoriteAddition(String productKey, String variantKey)	Sends a notification to the eSales service, about a product being added to favorites.
void	notifyFavoriteRemoval(String productKey, String variantKey)	Sends a notification to the eSales service, about a product being removed from favorites.
void	notifyNonEsalesAddingToCart(String productKey, String variantKey)	Sends a notification to the eSales service, about a non-eSales product being added to the shopping cart by a user in the session.
void	notifyNonEsalesClick(String productKey, String variantKey)	Sends a notification to the eSales service, about a non-eSales product click being made by the user in a session.
void	notifyPayment(Order order)	Sends a notification to the eSales service, about products and variants being paid by a user in the session.
void	notifyPayment(SKUList skus)	Deprecated. As of eSales 3.3, replaced by notifyPayment(Order order)..
void	notifyPayment(SKUList skus, double orderValue)	Deprecated. As of eSales 3.3, replaced by notifyPayment(Order order) and Order.withSellingPrice(double)..
void	notifyPayment(Iterable<String> productKeys)	Deprecated. As of eSales 3.3, replaced by notifyPayment(Order order).
void	notifyPayment(Iterable<String> productKeys, double orderValue)	Deprecated. As of eSales 3.3, replaced by notifyPayment(Order order).
void	notifyPayment(String ticketEnc)	Deprecated. As of eSales 3.3, replaced by notifyPayment(Order order) and Order.addTicket(String)..
void	notifyPayment(String ticketEnc, double orderValue)	Deprecated. As of eSales 3.3, replaced by notifyPayment(Order order) and Order.addTicket(String), Order.withSellingPrice(double)..
void	notifyProperty(String name, String value)	Sends a notification to the eSales service, about a session property being set. Later calls will overwrite the previous values of the property.
void	notifyRating(String productKey, int rating)	Sends a notification to the eSales service, about a product being rated.
Panel	panel(String path)	Returns a panel specified by the path supplied as argument.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

panel

public Panel panel(String path)

Returns a panel specified by the path supplied as argument.

Parameters:

path - The path of the panel

Returns:

A Panel object with the specified path

dynamicPage

public DynamicPage dynamicPage(String name)

Creates a dynamic page with the specified name.

Parameters:

name - The name of the dynamic page

Returns:

A DynamicPage object with the specified name

notifyProperty

public void notifyProperty(String name,
                           String value)
                    throws IOException

Sends a notification to the eSales service, about a session property being set.
Later calls will overwrite the previous values of the property. If the property name is market or customer_key, then the market or customer_key for this session object will be changed accordingly.

Parameters:

name - The name of the property. Any valid Java identifier may be used.

value - The value of the property.

Throws:

IOException - if the notification cannot be sent to the eSales service

IllegalArgumentException - if name or value is null or empty

notifyClick

public void notifyClick(String ticketEnc)
                 throws IOException

Sends a notification to the eSales service, about a click being made by the user in a session.

Parameters:

ticketEnc - The ticked for the object that was clicked

Throws:

IOException - if the notification cannot be sent to the eSales service

IllegalArgumentException - if ticketEnc is null or empty

notifyAddingToCart

public void notifyAddingToCart(String ticketEnc)
                        throws IOException

Sends a notification to the eSales service, about a product being added to the shopping cart by a user in the session.

Parameters:

ticketEnc - The ticked for the object that was added to the cart

Throws:

IOException - if the notification cannot be sent to the eSales service

IllegalArgumentException - if ticketEnc is null or empty

notifyNonEsalesClick

public void notifyNonEsalesClick(String productKey,
                                 String variantKey)
                          throws IOException

Sends a notification to the eSales service, about a non-eSales product click being made by the user in a session. This method should only be used on non-eSales rendered products where no ticket is available.

Parameters:

productKey - The product key of the clicked product or may be null if you have a variant key.

variantKey - The variant key of the clicked variant or null if it is a click on a product only.

Throws:

IOException - If the notification cannot be sent to the eSales service.

IllegalArgumentException - If productKey or variantKey are empty or both are null.

notifyNonEsalesAddingToCart

public void notifyNonEsalesAddingToCart(String productKey,
                                        String variantKey)
                                 throws IOException

Sends a notification to the eSales service, about a non-eSales product being added to the shopping cart by a user in the session. This method should only be used on non-eSales rendered products where no ticket is available.

Parameters:

productKey - The product key of the added to cart product or may be null if you have a variant key.

variantKey - The variant key of the variant or null if it is an add to cart on a product only.

Throws:

IOException - If the notification cannot be sent to the eSales service.

IllegalArgumentException - If productKey or variantKey are empty or both are null.

notifyPayment

public void notifyPayment(Order order)
                   throws IOException

Sends a notification to the eSales service, about products and variants being paid by a user in the session.

Parameters:

order - Order containing the paid products and variants

Throws:

IOException - if the notification could not be sent to the eSales service or if the eSales service failed to respond

IllegalArgumentException - if order is null or empty

notifyPayment

@Deprecated
public void notifyPayment(Iterable<String> productKeys)
                   throws IOException

Deprecated.

As of eSales 3.3, replaced by notifyPayment(Order order).

Sends a notification to the eSales service, about products being paid by a user in the session.

Parameters:

productKeys - Iterable<String> product keys of the paid products

Throws:

IOException - if the notification cannot be sent to the eSales service

notifyPayment

@Deprecated
public void notifyPayment(Iterable<String> productKeys,
                          double orderValue)
                   throws IOException

Deprecated.

As of eSales 3.3, replaced by notifyPayment(Order order).

Sends a notification to the eSales service, about products being paid by a user in the session.

Parameters:

productKeys - Iterable<String> product keys of the paid products

orderValue - A total value for this order

Throws:

IOException - if the notification cannot be sent to the eSales service

notifyPayment

@Deprecated
public void notifyPayment(SKUList skus)
                   throws IOException

Deprecated.

As of eSales 3.3, replaced by notifyPayment(Order order)..

Sends a notification to the eSales service, about products and variants being paid by a user in the session.

Parameters:

skus - SKUList containing the paid products and variants, this list must not be empty

Throws:

IOException - if the notification cannot be sent to the eSales service

notifyPayment

@Deprecated
public void notifyPayment(SKUList skus,
                          double orderValue)
                   throws IOException

Deprecated.

As of eSales 3.3, replaced by notifyPayment(Order order) and Order.withSellingPrice(double)..

Sends a notification to the eSales service, about products and variants being paid by a user in the session.

Parameters:

skus - SKUList containing the paid products and variants, this list must not be empty

orderValue - A total value for this order

Throws:

IOException - if the notification cannot be sent to the eSales service

notifyPayment

@Deprecated
public void notifyPayment(String ticketEnc)
                   throws IOException

Deprecated.

As of eSales 3.3, replaced by notifyPayment(Order order) and Order.addTicket(String)..

Sends a notification to the eSales service, about products being paid by a user in the session.

Parameters:

ticketEnc - The ticked for the object that was purchased

Throws:

IOException - if the notification cannot be sent to the eSales service

notifyPayment

@Deprecated
public void notifyPayment(String ticketEnc,
                          double orderValue)
                   throws IOException

Deprecated.

As of eSales 3.3, replaced by notifyPayment(Order order) and Order.addTicket(String), Order.withSellingPrice(double)..

Sends a notification to the eSales service, about products being paid by a user in the session.

Parameters:

ticketEnc - The ticked for the object that was purchased

orderValue - A total value for this order.

Throws:

IOException - if the notification cannot be sent to the eSales service

notifyRating

public void notifyRating(String productKey,
                         int rating)
                  throws IOException

Sends a notification to the eSales service, about a product being rated.

Parameters:

productKey - the key of the rated product

rating - the rating

Throws:

IOException - if the notification cannot be sent to the eSales service

IllegalArgumentException - if product_key is null or empty

notifyFavoriteAddition

public void notifyFavoriteAddition(String productKey,
                                   String variantKey)
                            throws IOException

Sends a notification to the eSales service, about a product being added to favorites.

Parameters:

productKey - The product key of the favorite product or may be null if you have a variant key.

variantKey - The variant key of the favorite. Can be null if a product key is provided. The variant key should always be set if the product has variants.

Throws:

IOException - If the notification cannot be sent to the eSales service.

IllegalArgumentException - If productKey or variantKey are empty or both are null.

notifyFavoriteRemoval

public void notifyFavoriteRemoval(String productKey,
                                  String variantKey)
                           throws IOException

Sends a notification to the eSales service, about a product being removed from favorites.

Parameters:

productKey - The product key of the favorite product or may be null if you have a variant key.

variantKey - The variant key of the favorite. Can be null if a product key is provided. The variant key should always be set if the product has variants.

Throws:

IOException - If the notification cannot be sent to the eSales service.

IllegalArgumentException - If productKey or variantKey are empty or both are null.

end

public boolean end()

Notifies the eSales service that the session has ended.

Returns:

true if the notification has been sent successfully, false otherwise

key

public final String key()

Returns:

the session key.

market

public final String market()

Returns:

the session's market or null if no market has been set.

customerKey

public final String customerKey()

Returns:

the session's customer_key or null if no customer_key has been set.