public interface Event extends Cloneable
Modifier and Type | Method and Description |
---|---|
Event |
add(String key,
String value)
Add to the log message.
|
String |
createEntityHierarchyMessage(String parentType,
String parentID,
String childIdType,
Collection<String> childIDs)
Creates a log message that connects the parent entities with the
children.
|
String |
createLogMessage()
Creates a log message with the contents of the internal log buffer.
|
String |
createLogMessageAndReset()
Creates a log message with the contents of the internal log buffer.
|
String |
getEndEventMessage()
Creates the end message for the event.
|
String |
getEventName()
Returns the name of event that is currently associated with the log messages.
|
String |
getProgramName(String name)
Returns the program name for the software whose log statement are logged.
|
String |
getStartEventMessage()
Creates the start message for the event.
|
void |
reset()
Reset the internal log message buffer associated with the event
|
void |
setEvent(String name,
Map<String,String> map)
Adds the event that is to be associated with the log messages onto an
internal stack
|
void |
setEvent(String name,
String entityName,
String entityID)
Set the event that is to be associated with the log messages.
|
void |
setProgramName(String name)
Sets the program name for the software whose log statement are logged.
|
void setProgramName(String name)
name
- String getProgramName(String name)
name
- void setEvent(String name, String entityName, String entityID)
name
- the name of the event to be associatedentityName
- the primary entity that is associated with the event e.g. workflowentityID
- the id of that entity.void setEvent(String name, Map<String,String> map)
name
- the name of the event to be associatedmap
- Map of Entity Names with the entity identifiers.String getEventName()
String getStartEventMessage()
String getEndEventMessage()
void reset()
Event add(String key, String value)
key
- value
- String createLogMessage()
String createLogMessageAndReset()
String createEntityHierarchyMessage(String parentType, String parentID, String childIdType, Collection<String> childIDs)
parentType
- the type of parent entityparentID
- the id of the parent entitychildIdType
- the type of children entitieschildIDs
- Collection of children id's