psdi.webclient.system.controller

Class SetValueError

java.lang.Object

psdi.webclient.system.controller.SetValueError

Direct Known Subclasses:

SmartFillError

public class SetValueError
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SetValueError(ERMAttributeError attributeError, BoundComponentInstance component)
SetValueError(java.lang.String attribute, java.util.List<MXException> warnings, DataBean dataBean, int row, MboSetRemote mboSetRemote)
SetValueError(java.lang.String attribute, MXException exception, DataBean dataBean, int row, MboSetRemote mboSetRemote)

Method Summary

Modifier and Type	Method and Description
boolean	boundToSameMbo(SetValueError newError) Returns true if the error passed in is bound to the same Mbo as this SetValueError
boolean	equals(java.lang.Object o)
ApplicationError	getApplicationError() Returns the ApplicationError object associated with this class.
WebClientEvent	getAssociatedEvent() Returns the WebClientEvent associated with this error.
java.lang.String	getEnteredValue()
int	getErrorType() Returns the type of error.
MXException	getException() Returns the MXException associated with the error.
BoundComponentInstance	getInitialComponent() This method returns the BoundComponentInstance that basically created the error.
MboSetRemote	getMboSet() Gets the MboSet that the error occurred.
java.lang.String	getPreviousValue() Returns the previous value of the attribute
int	getRow() Returns the mbo index (row) assocaited with the error
java.lang.String	getUserDisplayValue()
java.util.List<MXException>	getWarnings() Returns a List of Warnings for the error
int	hasHigherError(int errorLevel) This method checks the passed in error level against the error level of this error and returns the error level that is more severe.
void	invalidate() Invalidates the error and cleans up any instances that need it
void	notifyMbo() This method will set the SetValueError (this) on the mbo and attribute associated with the error
void	resetErrorChecked() This method is called on the error after render in order for the error to "reset" itself to be validated again after the next event.
void	setAssociatedEvent(WebClientEvent associatedEvent) Sets the WebClientEvent associated with is error
void	setEnteredValue(java.lang.String enteredValue)
void	setInitialComponent(BoundComponentInstance component) This method sets the component that initially is associated this the error.
void	setPreviousValue(java.lang.String previousValue)
void	setUserDisplayValue(java.lang.String userDisplayValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

SetValueError

public SetValueError(java.lang.String attribute,
                     java.util.List<MXException> warnings,
                     DataBean dataBean,
                     int row,
                     MboSetRemote mboSetRemote)

SetValueError

public SetValueError(java.lang.String attribute,
                     MXException exception,
                     DataBean dataBean,
                     int row,
                     MboSetRemote mboSetRemote)

SetValueError

public SetValueError(ERMAttributeError attributeError,
                     BoundComponentInstance component)

Method Detail

notifyMbo

public void notifyMbo()

This method will set the SetValueError (this) on the mbo and attribute associated with the error

getRow

public int getRow()

Returns the mbo index (row) assocaited with the error

Returns:

getWarnings

public java.util.List<MXException> getWarnings()

Returns a List of Warnings for the error

Returns:

getException

public MXException getException()

Returns the MXException associated with the error.

Returns:

getErrorType

public int getErrorType()

Returns the type of error. Can be one of the following:
BaseInstance.EXCEPTION_YESNOCANCEL
BaseInstance.EXCEPTION_ERROR
BaseInstance.EXCEPTION_WARNING
BaseInstance.EXCEPTION_NONE
If EXCEPTION_NONE is return you can consider this error no longer valid (this is no longer an error)

Returns:

The type of error

invalidate

public void invalidate()

Invalidates the error and cleans up any instances that need it

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getMboSet

public MboSetRemote getMboSet()

Gets the MboSet that the error occurred.

Parameters:

mboSet -

resetErrorChecked

public void resetErrorChecked()

This method is called on the error after render in order for the error to "reset" itself to be validated again after the next event.

getPreviousValue

public java.lang.String getPreviousValue()

Returns the previous value of the attribute

Returns:

the previous value

getUserDisplayValue

public java.lang.String getUserDisplayValue()

Returns:

the userDisplayValue

getEnteredValue

public java.lang.String getEnteredValue()

Returns:

the enteredValue

setPreviousValue

public void setPreviousValue(java.lang.String previousValue)

Parameters:

previousValue - the previousValue to set

setEnteredValue

public void setEnteredValue(java.lang.String enteredValue)

Parameters:

enteredValue - the enteredValue to set

setUserDisplayValue

public void setUserDisplayValue(java.lang.String userDisplayValue)

Parameters:

userDisplayValue - the userDisplayValue to set

hasHigherError

public int hasHigherError(int errorLevel)

This method checks the passed in error level against the error level of this error and returns the error level that is more severe. This method will check to see if the error (this) is still valid.

Parameters:

errorLevel - error level to compare against the error level of this object

Returns:

the most severe error level when comparing the passed in error level and this object's

getAssociatedEvent

public WebClientEvent getAssociatedEvent()

Returns the WebClientEvent associated with this error. This can return null.

Returns:

the associatedEvent

setAssociatedEvent

public void setAssociatedEvent(WebClientEvent associatedEvent)

Sets the WebClientEvent associated with is error

Parameters:

associatedEvent - the associatedEvent to set

boundToSameMbo

public boolean boundToSameMbo(SetValueError newError)

Returns true if the error passed in is bound to the same Mbo as this SetValueError

Parameters:

newError -

componentDataBean -

Returns:

setInitialComponent

public void setInitialComponent(BoundComponentInstance component)

This method sets the component that initially is associated this the error. In a sense it's the component that generated the error (or the error's owner). Other components can be bound to the same attribute and share this error.

Parameters:

component -

getInitialComponent

public BoundComponentInstance getInitialComponent()

This method returns the BoundComponentInstance that basically created the error. It's the original "owner" of the error. Other components can be bound to the same attribute and share this error.

Returns:

getApplicationError

public ApplicationError getApplicationError()

Returns the ApplicationError object associated with this class. The ApplicationError object is the object passed to the Mbo not notify the Mbo of the ApplicationErorr. Will return null if this class has been invalidated.

Returns: