Package lumis.portal.analytics.journey

Class Journey

java.lang.Object

lumis.portal.analytics.journey.Journey

All Implemented Interfaces:

java.lang.Cloneable, ITimeoutAwareJourneyElement, ICacheEntry, ICloneableCacheEntry

public class Journey
extends java.lang.Object
implements ICloneableCacheEntry, ITimeoutAwareJourneyElement

Represents a user journey.

Since:

12.2.0

Version:

$Revision$ $Date$

Method Summary

Modifier and Type	Method	Description
JourneyStage	addStage(java.lang.String name, int position, boolean isJourneyStart, boolean journeyEnd, boolean createUserSegmentation, java.util.concurrent.TimeUnit timeoutUnit, int timeoutAmount)	Adds a stage in this journey.
java.lang.Object	clone()
java.lang.String	getId()	Returns the id.
java.lang.String	getName()	Returns the name.
java.lang.String	getServiceInstanceId()	Returns the serviceInstanceId.
java.util.Collection<JourneyStage>	getStages()	Returns the stages.
int	getTimeoutAmount()	Returns the timeoutAmount.
java.util.concurrent.TimeUnit	getTimeoutUnit()	Returns the timeoutUnit.
void	setName(java.lang.String name)	Sets the name.
void	setTimeoutAmount(int timeoutAmount)	Sets the timeoutAmount.
void	setTimeoutUnit(java.util.concurrent.TimeUnit timeoutUnit)	Sets the timeoutUnit.

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.portal.analytics.journey.ITimeoutAwareJourneyElement

getTimeoutMillis

Method Detail

getServiceInstanceId

public java.lang.String getServiceInstanceId()

Returns the serviceInstanceId.

Returns:

the serviceInstanceId

Since:

12.2.0

getName

public java.lang.String getName()

Returns the name.

Returns:

the name

Since:

12.2.0

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - the name value to set.

Since:

12.2.0

getId

public java.lang.String getId()

Returns the id.

Returns:

the id

Since:

12.2.0

getTimeoutUnit

public java.util.concurrent.TimeUnit getTimeoutUnit()

Description copied from interface: ITimeoutAwareJourneyElement

Returns the timeoutUnit.

Specified by:

getTimeoutUnit in interface ITimeoutAwareJourneyElement

Returns:

the timeoutUnit

setTimeoutUnit

public void setTimeoutUnit(java.util.concurrent.TimeUnit timeoutUnit)

Description copied from interface: ITimeoutAwareJourneyElement

Sets the timeoutUnit.

Specified by:

setTimeoutUnit in interface ITimeoutAwareJourneyElement

Parameters:

timeoutUnit - the timeoutUnit value to set.

getTimeoutAmount

public int getTimeoutAmount()

Description copied from interface: ITimeoutAwareJourneyElement

Returns the timeoutAmount.

Specified by:

getTimeoutAmount in interface ITimeoutAwareJourneyElement

Returns:

the timeoutAmount

setTimeoutAmount

public void setTimeoutAmount(int timeoutAmount)

Description copied from interface: ITimeoutAwareJourneyElement

Sets the timeoutAmount.

Specified by:

setTimeoutAmount in interface ITimeoutAwareJourneyElement

Parameters:

timeoutAmount - the timeoutAmount value to set.

addStage

public JourneyStage addStage(java.lang.String name,
                             int position,
                             boolean isJourneyStart,
                             boolean journeyEnd,
                             boolean createUserSegmentation,
                             java.util.concurrent.TimeUnit timeoutUnit,
                             int timeoutAmount)
                      throws PortalException

Adds a stage in this journey.

Parameters:

name - the stage name.

position - the stage position.

isJourneyStart - indicates whether the stage is a journey start.

journeyEnd - indicates whether the stage is a journey end.

createUserSegmentation - indicates whether a user segmentation should be created for this stage.

timeoutUnit - the timeout unit

timeoutAmount - the timeout amount

Returns:

the created stage.

Throws:

PortalException

Since:

12.2.0

getStages

public java.util.Collection<JourneyStage> getStages()
                                             throws PortalException

Returns the stages.

Returns:

the stages

Throws:

PortalException

Since:

12.2.0

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Specified by:

clone in interface ICloneableCacheEntry

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException