atg.markers.bp

Class BusinessProcessEventMessage

java.lang.Object

atg.markers.MarkerEventMessage

atg.markers.bp.BusinessProcessEventMessage

All Implemented Interfaces:

java.io.Serializable

public class BusinessProcessEventMessage
extends MarkerEventMessage

This class defines the base properties for a business process event message.

These messages are created by the BusinessProcessManager.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mBusinessProcessName
protected java.lang.String	mBusinessProcessStage
protected int	mBusinessProcessStageSequence
protected java.sql.Timestamp	mProcessStartTime
protected boolean	mTransient

Constructor Summary

Constructors

Constructor and Description
BusinessProcessEventMessage() Constructs a BusinessProcessEventMessage message

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBusinessProcessName() Returns the business process name associated with the event.
java.lang.String	getBusinessProcessStage() Returns the business process stage that was reached
int	getBusinessProcessStageSequence() Returns the sequence number of the business process stage that was reached
java.sql.Timestamp	getProcessStartTime() Gets the time the process was started.
boolean	isTransient() Gets the transient state of the user profile when the event was created.
void	setBusinessProcessName(java.lang.String pBusinessProcessName) The business process name associated with the event.
void	setBusinessProcessStage(java.lang.String pBusinessProcessStage) Sets the business process stage that was reached
void	setBusinessProcessStageSequence(int pBusinessProcessStageSequence) Sets the sequence number of the business process stage that was reached
void	setProcessStartTime(java.sql.Timestamp pProcessStartTime) Sets the time the process was started.
void	setTransient(boolean pTransient) Sets the transient state of the user profile when the event was created.

Methods inherited from class atg.markers.MarkerEventMessage

getEventDate, getMarkedItemId, getMarkedItemType, getMarkerPropertyName, getParentSessionId, getProfileId, getRepositoryName, getSessionId, getSiteId, setEventDate, setMarkedItemId, setMarkedItemType, setMarkerPropertyName, setParentSessionId, setProfileId, setRepositoryName, setSessionId, setSiteId

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mBusinessProcessName

protected java.lang.String mBusinessProcessName

mBusinessProcessStage

protected java.lang.String mBusinessProcessStage

mBusinessProcessStageSequence

protected int mBusinessProcessStageSequence

mProcessStartTime

protected java.sql.Timestamp mProcessStartTime

mTransient

protected boolean mTransient

Constructor Detail

BusinessProcessEventMessage

public BusinessProcessEventMessage()

Constructs a BusinessProcessEventMessage message

Method Detail

setBusinessProcessName

public void setBusinessProcessName(java.lang.String pBusinessProcessName)

The business process name associated with the event.

getBusinessProcessName

public java.lang.String getBusinessProcessName()

Returns the business process name associated with the event.

setBusinessProcessStage

public void setBusinessProcessStage(java.lang.String pBusinessProcessStage)

Sets the business process stage that was reached

getBusinessProcessStage

public java.lang.String getBusinessProcessStage()

Returns the business process stage that was reached

setBusinessProcessStageSequence

public void setBusinessProcessStageSequence(int pBusinessProcessStageSequence)

Sets the sequence number of the business process stage that was reached

getBusinessProcessStageSequence

public int getBusinessProcessStageSequence()

Returns the sequence number of the business process stage that was reached

setProcessStartTime

public void setProcessStartTime(java.sql.Timestamp pProcessStartTime)

Sets the time the process was started.

Parameters:

pProcessStartTime - the time

getProcessStartTime

public java.sql.Timestamp getProcessStartTime()

Gets the time the process was started.

Returns:

Timestamp

setTransient

public void setTransient(boolean pTransient)

Sets the transient state of the user profile when the event was created.

Parameters:

pTransient - new value to set

isTransient

public boolean isTransient()

Gets the transient state of the user profile when the event was created.

Returns:

boolean