com.atinternet.tracker

Class AbstractScreen

java.lang.Object

com.atinternet.tracker.BusinessObject

com.atinternet.tracker.AbstractScreen

Direct Known Subclasses:

DynamicScreen, Screen

public abstract class AbstractScreen
extends BusinessObject

Abstract class to manage screen tracking

Method Summary

Modifier and Type	Method and Description
Aisle	Aisle(java.lang.String level1) Attach visited aisle information to screen
Campaign	Campaign(java.lang.String campaignId) Attach campaign information to screen
CustomObjects	CustomObjects() Get a wrapper for CustomObject management
CustomTreeStructure	CustomTreeStructure(int category1) Attach a custom tree structure to screen
CustomVars	CustomVars() Get a wrapper for CustomVar management
com.atinternet.tracker.AbstractScreen.Action	getAction() Get the action type
java.lang.String	getChapter1() Get the first chapter
java.lang.String	getChapter2() Get the second chapter
java.lang.String	getChapter3() Get the third chapter
int	getLevel2() Get the level 2
java.lang.String	getLevel2String() Get the level 2 string
java.lang.String	getName() Get the screen name
InternalSearch	InternalSearch(java.lang.String keywordLabel, int resultScreenNumber) Attach internal search information to screen
boolean	isBasketScreen() Get "isBasketScreen" value
Location	Location(double latitude, double longitude) Attach location information to screen
Order	Order(java.lang.String orderId, double turnover) Deprecated. Since 2.3.4, bug was revealed when this method is used. Use Orders tracker property instead.
PublisherImpressions	Publishers() Get a wrapper for PublisherImpression management
SelfPromotionImpressions	SelfPromotions() Get a wrapper for SelfPromotionImpression management
void	sendView() Send the screen view event
void	setCart(Cart cart) Attach a cart to screen

Methods inherited from class com.atinternet.tracker.BusinessObject

getId, setTimestamp

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Get the screen name

Returns:

the screen name

getAction

public com.atinternet.tracker.AbstractScreen.Action getAction()

Get the action type

Returns:

the action type

getLevel2

public int getLevel2()

Get the level 2

Returns:

the level 2

getLevel2String

public java.lang.String getLevel2String()

Get the level 2 string

Returns:

the level 2

getChapter1

public java.lang.String getChapter1()

Get the first chapter

Returns:

the first chapter

getChapter2

public java.lang.String getChapter2()

Get the second chapter

Returns:

the second chapter

getChapter3

public java.lang.String getChapter3()

Get the third chapter

Returns:

the third chapter

isBasketScreen

public boolean isBasketScreen()

Get "isBasketScreen" value

Returns:

true is screen is basket screen

setCart

public void setCart(Cart cart)

Attach a cart to screen

Parameters:

cart - the cart instance

Location

public Location Location(double latitude,
                         double longitude)

Attach location information to screen

Parameters:

latitude - latitude x value

longitude - longitude y value

Returns:

the Location instance

Aisle

public Aisle Aisle(java.lang.String level1)

Attach visited aisle information to screen

Parameters:

level1 - first aisle level

Returns:

the Aisle instance

CustomTreeStructure

public CustomTreeStructure CustomTreeStructure(int category1)

Attach a custom tree structure to screen

Parameters:

category1 - first custom tree structure category

Returns:

the CustomTreeStructure instance

Campaign

public Campaign Campaign(java.lang.String campaignId)

Attach campaign information to screen

Parameters:

campaignId - campaign identifier

Returns:

the Campaign identifier

Order

@Deprecated
public Order Order(java.lang.String orderId,
                               double turnover)

Deprecated. Since 2.3.4, bug was revealed when this method is used. Use Orders tracker property instead.

Attach an order to screen

Parameters:

orderId - order identifier

turnover - order turnover

Returns:

the Order instance

InternalSearch

public InternalSearch InternalSearch(java.lang.String keywordLabel,
                                     int resultScreenNumber)

Attach internal search information to screen

Parameters:

keywordLabel - keyword has been searched

resultScreenNumber - screen result number

Returns:

the InternalSearch instance

CustomVars

public CustomVars CustomVars()

Get a wrapper for CustomVar management

Returns:

CustomVars instance

CustomObjects

public CustomObjects CustomObjects()

Get a wrapper for CustomObject management

Returns:

CustomObjects instance

Publishers

public PublisherImpressions Publishers()

Get a wrapper for PublisherImpression management

Returns:

PublisherImpressions instance

SelfPromotions

public SelfPromotionImpressions SelfPromotions()

Get a wrapper for SelfPromotionImpression management

Returns:

SelfPromotionImpressions instance

sendView

public void sendView()

Send the screen view event