com.cs.software.engine.timer

Class TimerMessage

java.lang.Object

com.cs.software.engine.Message

com.cs.software.engine.timer.TimerMessage

All Implemented Interfaces:

MessageIntf, Serializable

public class TimerMessage
extends Message

The RevportMessage class encapsulates all the information required by a RevportEngine to perform the operation(s) it supports.

Since:

JDK 1.7

Author:

Steve Crombie

See Also:

Serialized Form

Field Summary

Fields inherited from class com.cs.software.engine.Message

ENGINE_DATAFLOW, ENGINE_KAFKA_CONSUMER, ENGINE_TYPE_MSG, MESSAGE_CONTROL_PROCESSEND, MESSAGE_CONTROL_PROCESSSTART, MESSAGE_CONTROL_SHUTDOWN, MESSAGE_DATA, MESSAGE_GET, MESSAGE_HB, MESSAGE_INIT, PARAM_PARENT_DATAFLOW, PARAM_PARENT_SERVICE, PARAM_PARENT_STATUS, PARAM_PARENT_STEPNUMBER, PARAM_ROUTE_FAIL, PARAM_ROUTE_PASS, PROCESSING_STATUS_COMPLETE, PROCESSING_STATUS_RUNNING, PROCESSING_STATUS_START, PROCESSING_STATUS_WAIT, ROUTE_INPROCESS, ROUTE_MESSAGE, TOTAL_ENGINES

Fields inherited from interface com.cs.software.api.MessageIntf

ERROR_CODE_FAILED, ERROR_CODE_SUCCESS, ERROR_CODE_WARNING

Constructor Summary

Constructors

Constructor and Description
TimerMessage()
TimerMessage(String aTimerCategory, String aTimerClass, Long anUserId)
TimerMessage(TimerMessage aSrcMsg) Creates a RevportMessage based upon the specified message.

Method Summary

Modifier and Type	Method and Description
Long	getBusinessWorkGroup()
String	getClassName()
String	getCSVStr()
Long	getDataFlowQueueId()
Date	getEndDate()
Long	getEventKeyId()
Long	getEventTypeId()
String	getMessageKey()
Map<String,Object>	getMessageMap()
Long	getParentWorkflowRuleGroupId()
Long	getParentWorkflowRuleGroupListId()
String	getPollEmailAddress()
long	getRepeatInterval()
Date	getStartDate()
String	getTimerCategory()
String	getTimerClass()
long	getTimerDelay(String aTimerDuration, int aTimerValue)
Long	getTimerId()
Long	getWorkflowRuleGroupId()
Long	getWorkflowRuleGroupListId()
boolean	isForcedWorkflowApproval()
void	setBusinessWorkGroup(Long aBusinessWorkGroupId)
void	setCSVStr(String aCsvStr)
void	setDataFlowQueueId(Long aDataFlowQueueId)
void	setEndDate(Date anEndDate)
void	setEventKeyId(Long anEventKeyId)
void	setEventTypeId(Long anEventTypeId)
void	setForcedWorkflowApproval(boolean aFlag)
void	setParentWorkflowRuleGroupId(Long aWorkflowRuleGroupId)
void	setParentWorkflowRuleGroupListId(Long aWorkflowRuleGroupListId)
void	setPollEmailAddress(String anEmailAddress)
void	setRepeatInterval(long aRepeatInterval)
void	setStartDate(Date aStartDate)
void	setTimerId(Long aTimerId)
void	setWorkflowRuleGroupId(Long aWorkflowRuleGroupId)
void	setWorkflowRuleGroupListId(Long aWorkflowRuleGroupListId)
String	toString()

Methods inherited from class com.cs.software.engine.Message

getCurrentDataFlow, getCurrentFailedStepNumber, getCurrentPassedStepNumber, getCurrentService, getCurrentStepNumber, getDataFlowParent, getDataFlowParentService, getDataFlowParentStatus, getDataFlowParentStepNumber, getDefError, getEndTime, getErrorCode, getErrorMessage, getEventType, getJobIdentifier, getJobIdentifierParent, getJobType, getLastActivityTime, getNextStatusStepNumber, getNextStatusStepNumber, getParam, getParamList, getParams, getPriorDataFlow, getPriorService, getPriorStepNumber, getRoute, getStartTime, getTotalTime, getUniqueId, getUserId, isCurrentServicePass, isMessageComplete, isPriorServicePass, setCurrent, setCurrentDataFlow, setCurrentFailedStepNumber, setCurrentPassedStepNumber, setCurrentService, setCurrentServicePass, setCurrentStepNumber, setDataFlowParent, setDataFlowParentService, setDataFlowParentStatus, setDataFlowParentStepNumber, setEndTime, setErrorCode, setErrorMessage, setEventType, setJobIdentifier, setJobIdentifierParent, setJobType, setLastActivityTime, setMessageComplete, setNextStatusStepNumber, setParam, setParams, setPriorDataFlow, setPriorService, setPriorServicePass, setPriorStepNumber, setRoute, setStartTime, setUserId

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerMessage

public TimerMessage()

TimerMessage

public TimerMessage(String aTimerCategory,
                    String aTimerClass,
                    Long anUserId)

TimerMessage

public TimerMessage(TimerMessage aSrcMsg)

Creates a RevportMessage based upon the specified message.

Parameters:

aSrcMsg - source message used to load parameters.

Method Detail

getMessageKey

public String getMessageKey()

getTimerCategory

public String getTimerCategory()

getTimerClass

public String getTimerClass()

getPollEmailAddress

public String getPollEmailAddress()

setPollEmailAddress

public void setPollEmailAddress(String anEmailAddress)

getRepeatInterval

public long getRepeatInterval()

setRepeatInterval

public void setRepeatInterval(long aRepeatInterval)

getBusinessWorkGroup

public Long getBusinessWorkGroup()

setBusinessWorkGroup

public void setBusinessWorkGroup(Long aBusinessWorkGroupId)

isForcedWorkflowApproval

public boolean isForcedWorkflowApproval()

setForcedWorkflowApproval

public void setForcedWorkflowApproval(boolean aFlag)

getEventTypeId

public Long getEventTypeId()

setEventTypeId

public void setEventTypeId(Long anEventTypeId)

getEventKeyId

public Long getEventKeyId()

setEventKeyId

public void setEventKeyId(Long anEventKeyId)

getWorkflowRuleGroupId

public Long getWorkflowRuleGroupId()

setWorkflowRuleGroupId

public void setWorkflowRuleGroupId(Long aWorkflowRuleGroupId)

getWorkflowRuleGroupListId

public Long getWorkflowRuleGroupListId()

setWorkflowRuleGroupListId

public void setWorkflowRuleGroupListId(Long aWorkflowRuleGroupListId)

getParentWorkflowRuleGroupId

public Long getParentWorkflowRuleGroupId()

setParentWorkflowRuleGroupId

public void setParentWorkflowRuleGroupId(Long aWorkflowRuleGroupId)

getParentWorkflowRuleGroupListId

public Long getParentWorkflowRuleGroupListId()

setParentWorkflowRuleGroupListId

public void setParentWorkflowRuleGroupListId(Long aWorkflowRuleGroupListId)

getTimerId

public Long getTimerId()

setTimerId

public void setTimerId(Long aTimerId)

setCSVStr

public void setCSVStr(String aCsvStr)
               throws Exception

Throws:

Exception

getCSVStr

public String getCSVStr()

getMessageMap

public Map<String,Object> getMessageMap()

getDataFlowQueueId

public Long getDataFlowQueueId()

setDataFlowQueueId

public void setDataFlowQueueId(Long aDataFlowQueueId)

getClassName

public String getClassName()

getTimerDelay

public long getTimerDelay(String aTimerDuration,
                          int aTimerValue)
                   throws Exception

Throws:

Exception

getStartDate

public Date getStartDate()

setStartDate

public void setStartDate(Date aStartDate)

getEndDate

public Date getEndDate()

setEndDate

public void setEndDate(Date anEndDate)

toString

public String toString()

Overrides:

toString in class Object