Package com.aquima.interactions.trace.impl

Class TraceMessageBase

java.lang.Object

com.aquima.interactions.trace.impl.TraceMessageBase

All Implemented Interfaces:

ITraceMessage, Serializable

Direct Known Subclasses:

AggregateTraceMessage, AttributeDecisionTraceMessage, DocumentTraceMessage, ProcessTraceMessage, TraceMessage

public abstract class TraceMessageBase
extends Object
implements ITraceMessage

Base class for process engine trace messages.

Since:

9.2

Author:

A.Pragt

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TraceMessageBase(String applicationId, String type)	Default constructor for creating a trace message.

Method Summary

Modifier and Type	Method	Description
protected void	addProperty(String name, IValue value)	Adds a property to the message.
String	getApplicationId()	Returns the application id of the trace message, not null
String	getMessageType()	The action of the trace message, not null.
String[]	getPropertyNames()	Returns the names of the properties, not null.
IValue	getPropertyValue(String name)	Returns the value of a property, not null.

Methods inherited from class java.lang.Object

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

Constructor Detail

TraceMessageBase

protected TraceMessageBase(String applicationId,
                           String type)

Default constructor for creating a trace message.

Parameters:

applicationId - The application id to create a trace message for, cannot be null.

type - The type of trace message, cannot be null.

Method Detail

addProperty

protected void addProperty(String name,
                           IValue value)

Adds a property to the message.

Parameters:

name - The name of the property, not null.

value - The value of the property, not null.

getApplicationId

public String getApplicationId()

Description copied from interface: ITraceMessage

Returns the application id of the trace message, not null

Specified by:

getApplicationId in interface ITraceMessage

Returns:

The application id

getMessageType

public String getMessageType()

Description copied from interface: ITraceMessage

The action of the trace message, not null.

Specified by:

getMessageType in interface ITraceMessage

Returns:

The action of the message.

getPropertyNames

public String[] getPropertyNames()

Description copied from interface: ITraceMessage

Returns the names of the properties, not null.

Specified by:

getPropertyNames in interface ITraceMessage

Returns:

The property names.

getPropertyValue

public IValue getPropertyValue(String name)

Description copied from interface: ITraceMessage

Returns the value of a property, not null.

Specified by:

getPropertyValue in interface ITraceMessage

Parameters:

name - The name of the property, not null.

Returns:

The value of the property, not null.