MessageIntf (cssoftware-app 1.0.16 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

DataFlowMessage, DBPoolData, JVMData, KafkaMessage, Message, QueueData, QueueStats, ThreadPoolData, TimerMessage
```
public interface MessageIntf
extends Serializable
```
The Message class encapsulates all the information required by a Service to perform the operation(s) it supports.

Author:

Steve Crombie

Field Summary

Fields
Modifier and Type Field and Description

static int ERROR_CODE_FAILED

static int ERROR_CODE_SUCCESS

static int ERROR_CODE_WARNING

Fields
Modifier and Type	Field and Description
`static int`	`ERROR_CODE_FAILED`
`static int`	`ERROR_CODE_SUCCESS`
`static int`	`ERROR_CODE_WARNING`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getCurrentDataFlow()`
`String`	`getCurrentService()`
`int`	`getCurrentStepNumber()`
`String`	`getDataFlowParent()`
`String`	`getDataFlowParentService()`
`boolean`	`getDataFlowParentStatus()`
`String`	`getDataFlowParentStepNumber()`
`long`	`getEndTime()`
`int`	`getErrorCode()`
`String`	`getErrorMessage()`
`int`	`getEventType()`
`String`	`getJobIdentifier()`
`String`	`getJobIdentifierParent()`
`String`	`getJobType()`
`long`	`getLastActivityTime()`
`int`	`getNextStatusStepNumber()`
`int`	`getNextStatusStepNumber(boolean aFlag)`
`Object`	`getParam(String aKey)`
`List<String>`	`getParamList()`
`Map<String,Object>`	`getParams()`
`String`	`getPriorDataFlow()`
`String`	`getPriorService()`
`int`	`getPriorStepNumber()`
`String`	`getRoute()`
`long`	`getStartTime()`
`long`	`getTotalTime()`
`String`	`getUniqueId()`
`Long`	`getUserId()`
`boolean`	`isCurrentServicePass()`
`boolean`	`isMessageComplete()`
`boolean`	`isPriorServicePass()`
`void`	`setCurrent(String aCurrentDataFlow, String aServiceName, int aStepNumber, int aPassStepNumber, int aFailStepNumber, String aJobType, String aJobIdentifier)`
`void`	`setCurrentDataFlow(String aName)`
`void`	`setCurrentService(String aServiceName)`
`void`	`setCurrentServicePass(boolean aFlag)`
`void`	`setCurrentStepNumber(int aStepNumber)`
`void`	`setDataFlowParent(String aName)`
`void`	`setDataFlowParentService(String aServiceName)`
`void`	`setDataFlowParentStatus(boolean aStatus)`
`void`	`setDataFlowParentStepNumber(String aStepNumber)`
`void`	`setErrorCode(int aCode)`
`void`	`setErrorMessage(String aMsg)`
`void`	`setEventType(int aType)`
`void`	`setJobIdentifier(String aJobIdentifier)`
`void`	`setJobIdentifierParent(String aJobIdentifier)`
`void`	`setJobType(String aType)`
`void`	`setLastActivityTime()`
`void`	`setMessageComplete(boolean aFlag)`
`void`	`setNextStatusStepNumber(boolean aFlag, int aStepNumber)`
`void`	`setParam(String aKey, Object aKeyValue)`
`void`	`setParams(Map<String,Object> aParams)`
`void`	`setPriorDataFlow(String aName)`
`void`	`setPriorService(String aServiceName)`
`void`	`setPriorServicePass(boolean aFlag)`
`void`	`setPriorStepNumber(int aStepNumber)`
`void`	`setRoute(boolean aStatus, String aRoute)`
`void`	`setUserId(Long anUserId)`

Field Detail
- ERROR_CODE_SUCCESS
```
static final int ERROR_CODE_SUCCESS
```
  See Also:
  
  Constant Field Values
- ERROR_CODE_FAILED
```
static final int ERROR_CODE_FAILED
```
  See Also:
  
  Constant Field Values
- ERROR_CODE_WARNING
```
static final int ERROR_CODE_WARNING
```
  See Also:
  
  Constant Field Values

Method Detail

getUniqueId
```
String getUniqueId()
```

getStartTime
```
long getStartTime()
```

getLastActivityTime
```
long getLastActivityTime()
```

setLastActivityTime
```
void setLastActivityTime()
```

getEndTime
```
long getEndTime()
```

getTotalTime
```
long getTotalTime()
```

getEventType
```
int getEventType()
```

setEventType
```
void setEventType(int aType)
```

getUserId
```
Long getUserId()
```

setUserId
```
void setUserId(Long anUserId)
```

setCurrent

void setCurrent(String aCurrentDataFlow,
                String aServiceName,
                int aStepNumber,
                int aPassStepNumber,
                int aFailStepNumber,
                String aJobType,
                String aJobIdentifier)

getDataFlowParent
```
String getDataFlowParent()
```

setDataFlowParent
```
void setDataFlowParent(String aName)
```

getDataFlowParentService
```
String getDataFlowParentService()
```

setDataFlowParentService

void setDataFlowParentService(String aServiceName)

getDataFlowParentStepNumber
```
String getDataFlowParentStepNumber()
```

setDataFlowParentStatus

void setDataFlowParentStatus(boolean aStatus)

getDataFlowParentStatus
```
boolean getDataFlowParentStatus()
```

setDataFlowParentStepNumber

void setDataFlowParentStepNumber(String aStepNumber)

getPriorDataFlow
```
String getPriorDataFlow()
```

setPriorDataFlow
```
void setPriorDataFlow(String aName)
```

getPriorService
```
String getPriorService()
```

setPriorService

void setPriorService(String aServiceName)

getPriorStepNumber
```
int getPriorStepNumber()
```

setPriorStepNumber

void setPriorStepNumber(int aStepNumber)

isPriorServicePass
```
boolean isPriorServicePass()
```

setPriorServicePass

void setPriorServicePass(boolean aFlag)

getCurrentDataFlow
```
String getCurrentDataFlow()
```

setCurrentDataFlow
```
void setCurrentDataFlow(String aName)
```

getCurrentService
```
String getCurrentService()
```

setCurrentService

void setCurrentService(String aServiceName)

isCurrentServicePass
```
boolean isCurrentServicePass()
```

setCurrentServicePass

void setCurrentServicePass(boolean aFlag)

getCurrentStepNumber
```
int getCurrentStepNumber()
```

setCurrentStepNumber

void setCurrentStepNumber(int aStepNumber)

getNextStatusStepNumber

int getNextStatusStepNumber(boolean aFlag)

getNextStatusStepNumber
```
int getNextStatusStepNumber()
```

setNextStatusStepNumber

void setNextStatusStepNumber(boolean aFlag,
                             int aStepNumber)

getParam
```
Object getParam(String aKey)
```

setParam

void setParam(String aKey,
              Object aKeyValue)

getParams
```
Map<String,Object> getParams()
```

setParams

void setParams(Map<String,Object> aParams)

getParamList
```
List<String> getParamList()
```

isMessageComplete
```
boolean isMessageComplete()
```

setMessageComplete

void setMessageComplete(boolean aFlag)

getErrorCode
```
int getErrorCode()
```

setErrorCode
```
void setErrorCode(int aCode)
```

getErrorMessage
```
String getErrorMessage()
```

setErrorMessage
```
void setErrorMessage(String aMsg)
```

getJobType
```
String getJobType()
```

setJobType
```
void setJobType(String aType)
```

getJobIdentifier
```
String getJobIdentifier()
```

setJobIdentifier

void setJobIdentifier(String aJobIdentifier)

getJobIdentifierParent
```
String getJobIdentifierParent()
```

setJobIdentifierParent

void setJobIdentifierParent(String aJobIdentifier)

setRoute

void setRoute(boolean aStatus,
              String aRoute)

getRoute
```
String getRoute()
```

Interface MessageIntf

Field Summary

Method Summary

Field Detail

ERROR_CODE_SUCCESS

ERROR_CODE_FAILED

ERROR_CODE_WARNING

Method Detail

getUniqueId

getStartTime

getLastActivityTime

setLastActivityTime

getEndTime

getTotalTime

getEventType

setEventType

getUserId

setUserId

setCurrent

getDataFlowParent

setDataFlowParent

getDataFlowParentService

setDataFlowParentService

getDataFlowParentStepNumber

setDataFlowParentStatus

getDataFlowParentStatus

setDataFlowParentStepNumber

getPriorDataFlow

setPriorDataFlow

getPriorService

setPriorService

getPriorStepNumber

setPriorStepNumber

isPriorServicePass

setPriorServicePass

getCurrentDataFlow

setCurrentDataFlow

getCurrentService

setCurrentService

isCurrentServicePass

setCurrentServicePass

getCurrentStepNumber

setCurrentStepNumber

getNextStatusStepNumber

getNextStatusStepNumber

setNextStatusStepNumber

getParam

setParam

getParams

setParams

getParamList

isMessageComplete

setMessageComplete

getErrorCode

setErrorCode

getErrorMessage

setErrorMessage

getJobType

setJobType

getJobIdentifier

setJobIdentifier

getJobIdentifierParent

setJobIdentifierParent

setRoute

getRoute