com.atinternet.tracker

Class ParamOption

java.lang.Object

com.atinternet.tracker.ParamOption

public class ParamOption
extends java.lang.Object

Class to customize parameter options

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParamOption.RelativePosition Enum for relative position

Constructor Summary

Constructors

Constructor and Description
ParamOption() Default constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRelativeParameterKey() Get parameter key attached with relative position
ParamOption.RelativePosition	getRelativePosition() Get relative position parameter
java.lang.String	getSeparator() Get separator for a parameter with multiple values
boolean	isAppend() Get boolean "append" value
boolean	isEncode() Get boolean "encode" value
boolean	isPersistent() Get boolean "persistent" value
ParamOption	setAppend(boolean append) Set a new boolean "append" value
ParamOption	setEncode(boolean encode) Set a new boolean "encode" value
ParamOption	setPersistent(boolean isPermanent) Set a new boolean "persistent" value
ParamOption	setRelativeParameterKey(java.lang.String relativeParameterKey) Set a new relative position parameter key
ParamOption	setRelativePosition(ParamOption.RelativePosition relativePosition) Set a new relative position
ParamOption	setSeparator(java.lang.String separator) Set a new separator

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamOption

public ParamOption()

Default constructor

Method Detail

getRelativePosition

public ParamOption.RelativePosition getRelativePosition()

Get relative position parameter

Returns:

the relative position

getRelativeParameterKey

public java.lang.String getRelativeParameterKey()

Get parameter key attached with relative position

Returns:

the parameter key

isEncode

public boolean isEncode()

Get boolean "encode" value

Returns:

true if the parameter must be url encoded

getSeparator

public java.lang.String getSeparator()

Get separator for a parameter with multiple values

Returns:

values separator

isPersistent

public boolean isPersistent()

Get boolean "persistent" value

Returns:

true if the parameter must be present in all hits during session

isAppend

public boolean isAppend()

Get boolean "append" value

Returns:

true if parameter should have multiple values

setRelativePosition

public ParamOption setRelativePosition(ParamOption.RelativePosition relativePosition)

Set a new relative position

Parameters:

relativePosition - /

Returns:

ParamOption instance

setRelativeParameterKey

public ParamOption setRelativeParameterKey(java.lang.String relativeParameterKey)

Set a new relative position parameter key

Parameters:

relativeParameterKey - /

Returns:

ParamOption instance

setEncode

public ParamOption setEncode(boolean encode)

Set a new boolean "encode" value

Parameters:

encode - /

Returns:

ParamOption instance

setSeparator

public ParamOption setSeparator(java.lang.String separator)

Set a new separator

Parameters:

separator - /

Returns:

ParamOption instance

setPersistent

public ParamOption setPersistent(boolean isPermanent)

Set a new boolean "persistent" value

Parameters:

isPermanent - /

Returns:

ParamOption instance

setAppend

public ParamOption setAppend(boolean append)

Set a new boolean "append" value

Parameters:

append - /

Returns:

ParamOption instance