|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.cyclonecommerce.cybervan.api.InterchangeEventDescription
Represents the complete description of an event generated by the Interchange Server engine.
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 |
public static final java.lang.String CONSOLE_SEPARATOR
public static final java.lang.String LINE_SEPARATOR
Constructor Detail |
public 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)
oCompany
- oPartner
- sSource
- sClass
- sMethod
- nLevelType
- sMessage1
- sMessage2
- sRemedy
- oDocument
- oDate
- Method Detail |
public IntegrationDocument getDocument()
public java.lang.String getConsoleMessage()
public java.lang.String getCompleteMessage(java.lang.String lineSeparator)
public java.lang.String getEventMessage()
public java.lang.String getAlertTitle()
public java.lang.String getMessageParticulars()
public int getLevel()
public java.lang.String getDescription()
public java.lang.String getSource()
public java.lang.String getDetails()
public long getTime()
public void setDocument(IntegrationDocument document)
document
- The associated documentpublic void setLevel(int level)
level
- The event levelpublic void setDescription(java.lang.String description)
description
- public void setSource(java.lang.String source)
source
- The event sourcepublic void setDetails(java.lang.String details)
details
- The detailed descriptionpublic void setTime(long time)
time
- The event time in millisecondspublic java.lang.String getTimeString()
public int getEventCode()
InterchangeEvent
public void setEventCode(int value)
value
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |