com.cyclonecommerce.cybervan.api
Class InterchangeEventDescription

java.lang.Object
  |
  +--com.cyclonecommerce.cybervan.api.InterchangeEventDescription

All Implemented Interfaces:

java.io.Serializable

public class InterchangeEventDescription

extends java.lang.Object

implements java.io.Serializable

Represents the complete description of an event generated by the Interchange Server engine.

See Also:

Serialized Form

Field Summary

static java.lang.String	CONSOLE_SEPARATOR
static java.lang.String	LINE_SEPARATOR

Constructor Summary

InterchangeEventDescription()
Default Constructor Internal server use only

InterchangeEventDescription(com.cyclonecommerce.cybervan.controller.Company oCompany, com.cyclonecommerce.cybervan.controller.Partner oPartner, java.lang.String sSource, java.lang.String sClass, java.lang.String sMethod, int nLevelType, java.lang.String sMessage1, java.lang.String sMessage2, java.lang.String sRemedy, java.util.Date oDate, IntegrationDocument oDocument, java.lang.Throwable tCause, int sEventCode)
Parm Constructor Internal server use only

Method Summary

java.lang.String	getAlertTitle() Returns a formatted title description of the event appropriate for alerting
java.lang.String	getCompleteMessage(java.lang.String lineSeparator) Returns a formatted version of all available event information
java.lang.String	getConsoleMessage() Returns a formatted description of the event appropriate for console output.
java.lang.String	getDescription() Returns a description of the event
java.lang.String	getDetails() Returns a detailed description of the event
IntegrationDocument	getDocument() Get the document associated with the event.
int	getEventCode() Return the event code.
java.lang.String	getEventMessage() Returns a formatted description of the event appropriate for event logging.
int	getLevel() Returns the level of the event.
java.lang.String	getMessageParticulars() Returns a formatted description of the event appropriate for alerting
java.lang.String	getSource() Returns the source of the event
long	getTime() Returns the time the event occurred, in milliseconds
java.lang.String	getTimeString() Returns a textual description of the time the event occured
void	setDescription(java.lang.String description) Sets the description of the event Intended for Interchange Server use only.
void	setDetails(java.lang.String details) Sets the detailed description of the message Intended for Interchange Server use only.
void	setDocument(IntegrationDocument document) Sets the document associated with the event Intended for Interchange Server use only.
void	setEventCode(int value) sets the event code for this InterchangeEventDescription Intended for Interchange Server use only.
void	setLevel(int level) Sets the level of the event Intended for Interchange Server use only.
void	setSource(java.lang.String source) Sets the source of the message Intended for Interchange Server use only.
void	setTime(long time) Sets the time the event occured Intended for Interchange Server use only.

Methods inherited from class java.lang.Object

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

Field Detail

CONSOLE_SEPARATOR

public static final java.lang.String CONSOLE_SEPARATOR

LINE_SEPARATOR

public static final java.lang.String LINE_SEPARATOR

Constructor Detail

InterchangeEventDescription

public InterchangeEventDescription()

Default Constructor Internal server use only

InterchangeEventDescription

public InterchangeEventDescription(com.cyclonecommerce.cybervan.controller.Company oCompany,
                                   com.cyclonecommerce.cybervan.controller.Partner oPartner,
                                   java.lang.String sSource,
                                   java.lang.String sClass,
                                   java.lang.String sMethod,
                                   int nLevelType,
                                   java.lang.String sMessage1,
                                   java.lang.String sMessage2,
                                   java.lang.String sRemedy,
                                   java.util.Date oDate,
                                   IntegrationDocument oDocument,
                                   java.lang.Throwable tCause,
                                   int sEventCode)

Parm Constructor Internal server use only

Parameters:

oCompany -

oPartner -

sSource -

sClass -

sMethod -

nLevelType -

sMessage1 -

sMessage2 -

sRemedy -

oDocument -

oDate -

Method Detail

getDocument

public IntegrationDocument getDocument()

Get the document associated with the event. Returns null if

Returns:

Returns the document associated with the event. Returns null if not available or applicable

getConsoleMessage

public java.lang.String getConsoleMessage()

Returns a formatted description of the event appropriate for console output.

Returns:

Returns a formatted description of the event appropriate for console output.

getCompleteMessage

public java.lang.String getCompleteMessage(java.lang.String lineSeparator)

Returns a formatted version of all available event information

Returns:

Returns a formatted version of all available event information.

getEventMessage

public java.lang.String getEventMessage()

Returns a formatted description of the event appropriate for event logging.

Returns:

Returns a formatted description of the event appropriate for event logging.

getAlertTitle

public java.lang.String getAlertTitle()

Returns a formatted title description of the event appropriate for alerting

Returns:

Returns a formatted title description of the event appropriate for alerting

getMessageParticulars

public java.lang.String getMessageParticulars()

Returns a formatted description of the event appropriate for alerting

Returns:

Returns a formatted description of the event appropriate for alerting.

getLevel

public int getLevel()

Returns the level of the event.

Returns:

Return the event level.

getDescription

public java.lang.String getDescription()

Returns a description of the event

Returns:

Return the event description.

getSource

public java.lang.String getSource()

Returns the source of the event

Returns:

Return the event source.

getDetails

public java.lang.String getDetails()

Returns a detailed description of the event

Returns:

Return the detailed description of the event.

getTime

public long getTime()

Returns the time the event occurred, in milliseconds

Returns:

Returns the time the event occurred, in milliseconds.

setDocument

public void setDocument(IntegrationDocument document)

Sets the document associated with the event Intended for Interchange Server use only.

Parameters:

document - The associated document

setLevel

public void setLevel(int level)

Sets the level of the event Intended for Interchange Server use only.

Parameters:

level - The event level

setDescription

public void setDescription(java.lang.String description)

Sets the description of the event Intended for Interchange Server use only.

Parameters:

description -

setSource

public void setSource(java.lang.String source)

Sets the source of the message Intended for Interchange Server use only.

Parameters:

source - The event source

setDetails

public void setDetails(java.lang.String details)

Sets the detailed description of the message Intended for Interchange Server use only.

Parameters:

details - The detailed description

setTime

public void setTime(long time)

Sets the time the event occured Intended for Interchange Server use only.

Parameters:

time - The event time in milliseconds

getTimeString

public java.lang.String getTimeString()

Returns a textual description of the time the event occured

Returns:

Returns a textual description of the time the event occured.

getEventCode

public int getEventCode()

Return the event code.

Returns:

Return the event code.

See Also:

InterchangeEvent

setEventCode

public void setEventCode(int value)

sets the event code for this InterchangeEventDescription Intended for Interchange Server use only.

Parameters:

value -