org.ikasan.framework.error.model
Class ErrorOccurrence

java.lang.Object
  org.ikasan.framework.error.model.ErrorOccurrence

public class ErrorOccurrence
extends Object

This class represents an occurrence of an error in the system encapsulating as much as possible about the occurrence of that error

Author:

Ikasan Development Team

Constructor Summary

ErrorOccurrence(Throwable throwable, Event event, String moduleName, String flowName, String flowElementName, Date expiry, String actionTaken)
Constructor, to be used when the error relates to an Event

ErrorOccurrence(Throwable throwable, String moduleName, String initiatorName, Date expiry, String actionTaken)
Constructor to be used when there is no Event involved

Method Summary

String	getActionTaken() Accessor for actionTaken
String	getErrorDetail()
Event	getErrorEvent() Accessor for ErrorEvent
String	getErrorSummary()
String	getEventId()
ExcludedEvent	getExcludedEvent() Accessor for ExcludedEvent
Date	getExpiry()
String	getFlowElementName()
String	getFlowName()
Long	getId()
String	getInitiatorName()
Date	getLogTime()
String	getModuleName()
String	getUrl() Accessor for url
void	setActionTaken(String actionTaken) Mutator for actionTaken
void	setErrorDetail(String errorDetail)
void	setEventId(String eventId)
void	setExcludedEvent(ExcludedEvent excludedEvent) Setter for excluded Event TODO make this non public
void	setExpiry(Date expiry)
void	setFlowElementName(String flowElementName)
void	setFlowName(String flowName)
void	setId(Long id)
void	setInitiatorName(String initiatorName)
void	setLogTime(Date logTime)
void	setModuleName(String moduleName)
void	setUrl(String url) Mutator for url
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorOccurrence

public ErrorOccurrence(Throwable throwable,
                       Event event,
                       String moduleName,
                       String flowName,
                       String flowElementName,
                       Date expiry,
                       String actionTaken)

Constructor, to be used when the error relates to an Event

Parameters:

flowElementName -

flowName -

initiatorName -

moduleName -

expiry -

actionTaken -

ErrorOccurrence

public ErrorOccurrence(Throwable throwable,
                       String moduleName,
                       String initiatorName,
                       Date expiry,
                       String actionTaken)

Constructor to be used when there is no Event involved

Parameters:

throwable -

moduleName -

initiatorName -

expiry -

actionTaken -

Method Detail

getErrorDetail

public String getErrorDetail()

Returns:

the errorDetail

getEventId

public String getEventId()

Returns:

the eventId

getFlowElementName

public String getFlowElementName()

Returns:

the flowElementName

getFlowName

public String getFlowName()

Returns:

the flowName

getInitiatorName

public String getInitiatorName()

Returns:

the initiatorName

getLogTime

public Date getLogTime()

Returns:

the logTime

getModuleName

public String getModuleName()

Returns:

the moduleName

setErrorDetail

public void setErrorDetail(String errorDetail)

Parameters:

errorDetail - the errorDetail to set

setEventId

public void setEventId(String eventId)

Parameters:

eventId - the eventId to set

setFlowElementName

public void setFlowElementName(String flowElementName)

Parameters:

flowElementName - the flowElementName to set

setFlowName

public void setFlowName(String flowName)

Parameters:

flowName - the flowName to set

setInitiatorName

public void setInitiatorName(String initiatorName)

Parameters:

initiatorName - the initiatorName to set

setLogTime

public void setLogTime(Date logTime)

Parameters:

logTime - the logTime to set

setModuleName

public void setModuleName(String moduleName)

Parameters:

moduleName - the moduleName to set

getId

public Long getId()

Returns:

the id

getErrorSummary

public String getErrorSummary()

Returns:

maximum of first 100 characters of errorDetail

setId

public void setId(Long id)

Parameters:

id - the id to set

setExpiry

public void setExpiry(Date expiry)

Parameters:

expiry - the expiry to set

getExpiry

public Date getExpiry()

Returns:

the expiry

getExcludedEvent

public ExcludedEvent getExcludedEvent()

Accessor for ExcludedEvent

Returns:

excluded event if one exists

setExcludedEvent

public void setExcludedEvent(ExcludedEvent excludedEvent)

Setter for excluded Event TODO make this non public

Parameters:

excludedEvent -

setUrl

public void setUrl(String url)

Mutator for url

Parameters:

url -

getUrl

public String getUrl()

Accessor for url

Returns:

getActionTaken

public String getActionTaken()

Accessor for actionTaken

Returns:

actionTaken

setActionTaken

public void setActionTaken(String actionTaken)

Mutator for actionTaken

Parameters:

actionTaken -

getErrorEvent

public Event getErrorEvent()

Accessor for ErrorEvent

Returns:

errorEvent if any

toString

public String toString()

Overrides:

toString in class Object