com.ibm.commerce.component.bod

Class ProcessingOutcomeMessage

java.lang.Object

com.ibm.commerce.component.bod.ProcessingOutcomeMessage

All Implemented Interfaces:

java.io.Serializable

public class ProcessingOutcomeMessage
extends java.lang.Object
implements java.io.Serializable

A ProcessingOutcomeMessage is a description of why a particular noun failed to be processed. It contains error information.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Constructor Summary

Constructors

Constructor and Description
ProcessingOutcomeMessage() Default constructor
ProcessingOutcomeMessage(ECMessage pErrorMessage, java.lang.String localizedMessage, java.lang.String[] symptomData, java.lang.String pErrorCode) ProcessingOutcomeMessage constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorCode()
ECMessage	getErrorMessage()
java.lang.String	getLocalizedMessage() Gets a localized error message created from the service end
java.lang.String[]	getSymptomData() Returns the symptom data
void	setErrorCode(java.lang.String string) Sets the error code for this noun
void	setErrorMessage(ECMessage message) Sets an error message indicating why the corresponding value object failed to be processed
void	setLocalizedMessage(java.lang.String string) Sets a localized error message created from the service end
void	setSymptomData(java.lang.String[] strings) Sets the symptom data

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

ProcessingOutcomeMessage

public ProcessingOutcomeMessage()

Default constructor

ProcessingOutcomeMessage

public ProcessingOutcomeMessage(ECMessage pErrorMessage,
                                java.lang.String localizedMessage,
                                java.lang.String[] symptomData,
                                java.lang.String pErrorCode)

ProcessingOutcomeMessage constructor

Parameters:

pErrorMessage - the error message used in the given error

localizedMessage - the localized message corresponding to the given error message

symptomData - the symptom of the error

errorCode - the error code that is correspoinding to the error message.

Method Detail

getErrorMessage

public ECMessage getErrorMessage()

Returns:

an error message indicating why the corresponding value object failed to be processed

setErrorMessage

public void setErrorMessage(ECMessage message)

Sets an error message indicating why the corresponding value object failed to be processed

Parameters:

errorMessage - th error message to be set

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Gets a localized error message created from the service end

Returns:

localizedMessage the localized message to be used.

getSymptomData

public java.lang.String[] getSymptomData()

Returns the symptom data

Returns:

symptomData[] a list of symptom data for the error

setLocalizedMessage

public void setLocalizedMessage(java.lang.String string)

Sets a localized error message created from the service end

Parameters:

localizedMessage - the localized message to be used

setSymptomData

public void setSymptomData(java.lang.String[] strings)

Sets the symptom data

Parameters:

strings - the symptom data to be used.

getErrorCode

public java.lang.String getErrorCode()

Returns:

the error code for this noun

setErrorCode

public void setErrorCode(java.lang.String string)

Sets the error code for this noun

Parameters:

errorCode - the error code to be used.