ariba.ui.aribaweb.core
Class AWErrorInfo

java.lang.Object
  ariba.ui.aribaweb.core.AWErrorInfo

All Implemented Interfaces:

AWErrorBucket

public class AWErrorInfo
extends Object
implements AWErrorBucket

This class encapsulates information about an error or warning. Each error is identified by either a single key or a set of keys consist of value source, field path, and group name. The key(s) are then used for looking up errors of interest.

Field Summary

static int	FieldPathKeyIndex
static int	GroupNameKeyIndex
static int	NotDisplayed
static String	NullKey
static int	NumKeys
static int	SingleKeyIndex
static int	ValueSourceKeyIndex

Constructor Summary

AWErrorInfo(Object[] keys, String message, Object errantValue, boolean isWarning)
Constructor to build a multi-key error object.

AWErrorInfo(Object key, String message, Object errantValue, boolean isWarning)
Constructor to build a single-key error object.

AWErrorInfo(Object vs, String fieldPath, String groupName, String message, Object errantValue, boolean isWarning)

Method Summary

AWErrorBucket	add(AWErrorInfo error)
void	decrementDuplicateCount()
AWErrorInfo	get(int i)
AWComponent	getAssociatedDataTable()
Object	getAssociatedTableItem()
int	getDisplayOrder()
int	getDuplicateCount()
Object	getErrantValue()
List<AWErrorInfo>	getErrorInfos() Returns a list of all the AWErrorInfos in this.
List<AWErrorInfo>	getErrorInfos(Boolean validationErrors) Returns a list of all the error infos in this that satisfy the condition isValidationError() == validationErrors.
Object	getErrorSource()
Object	getFieldPath()
AWErrorInfo	getFirstError(Boolean isWarning)
Object	getGroupName()
AWEncodedString	getIndicatorId()
Object	getKey()
Object[]	getKeys()
String	getKeysAsString()
static String	getKeysAsString(Object[] keys)
String	getMessage()
static int	getNumberOfKeys(Object key)
int	getRegistrationOrder()
int	getUnnavigableDisplayOrder()
Object	getValueSource()
boolean	getWasAutoScrolled()
boolean	hasDuplicate()
boolean	hasErrorsWithSeverity(Boolean isWarning)
void	incrementDuplicateCount()
boolean	isDuplicateError(AWErrorInfo error)
boolean	isSameError(AWErrorInfo error)
boolean	isSingleErrorBucket()
boolean	isSingleKey()
boolean	isValidationError() Returns true if this error is a validation error in the sense that it was added to the error manager during the invocation of the validation handlers.
boolean	isWarning()
boolean	keysEqual(Object[] theirKeys)
boolean	keysEqualLoosely(Object[] theirKeys)
static Object[]	makeKeyArray(Object key)
static Object[]	makeKeyArray(Object vs, Object field, Object group)
void	setAssociatedTableItem(AWComponent table, Object item)
void	setDisplayOrder(int order)
void	setErrorSource(Object source)
void	setIndicatorId(AWEncodedString id)
void	setRegistrationOrder(int order)
void	setUnnavigableDisplayOrder(int order)
void	setValidationError(boolean value) Sets whether or not this is a validation error.
void	setWasAutoScrolled(boolean scrolled)
int	size()
String	toString()
String	toString(Logger log)

Methods inherited from class java.lang.Object

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

Field Detail

NumKeys

public static final int NumKeys

See Also:

Constant Field Values

ValueSourceKeyIndex

public static final int ValueSourceKeyIndex

See Also:

Constant Field Values

FieldPathKeyIndex

public static final int FieldPathKeyIndex

See Also:

Constant Field Values

GroupNameKeyIndex

public static final int GroupNameKeyIndex

See Also:

Constant Field Values

SingleKeyIndex

public static final int SingleKeyIndex

See Also:

Constant Field Values

NullKey

public static final String NullKey

See Also:

Constant Field Values

NotDisplayed

public static final int NotDisplayed

See Also:

Constant Field Values

Constructor Detail

AWErrorInfo

public AWErrorInfo(Object key,
                   String message,
                   Object errantValue,
                   boolean isWarning)

Constructor to build a single-key error object.

Parameters:

key - The object that identifies the error.

message - The message that describes the error.

errantValue - The unparsable value that the user entered. Since the parsing failed, we cannot store this value in the field. We stash it away here so we can display in the UI.

isWarning - Indicate that this error severity is a warning.

AWErrorInfo

public AWErrorInfo(Object[] keys,
                   String message,
                   Object errantValue,
                   boolean isWarning)

Constructor to build a multi-key error object.

Parameters:

keys - Expected to contain value source, field path, and group name.

message - The message that describes the error.

errantValue - The unparsable value that the user entered. Since the parsing failed, we cannot store this value in the field. We stash it away here so we can display in the UI.

isWarning - Indicate that this error severity is a warning.

AWErrorInfo

public AWErrorInfo(Object vs,
                   String fieldPath,
                   String groupName,
                   String message,
                   Object errantValue,
                   boolean isWarning)

Method Detail

isSingleKey

public boolean isSingleKey()

getNumberOfKeys

public static int getNumberOfKeys(Object key)

makeKeyArray

public static Object[] makeKeyArray(Object key)

makeKeyArray

public static Object[] makeKeyArray(Object vs,
                                    Object field,
                                    Object group)

isWarning

public boolean isWarning()

getDisplayOrder

public int getDisplayOrder()

Specified by:

getDisplayOrder in interface AWErrorBucket

setDisplayOrder

public void setDisplayOrder(int order)

getUnnavigableDisplayOrder

public int getUnnavigableDisplayOrder()

Specified by:

getUnnavigableDisplayOrder in interface AWErrorBucket

setUnnavigableDisplayOrder

public void setUnnavigableDisplayOrder(int order)

getRegistrationOrder

public int getRegistrationOrder()

Specified by:

getRegistrationOrder in interface AWErrorBucket

setRegistrationOrder

public void setRegistrationOrder(int order)

Specified by:

setRegistrationOrder in interface AWErrorBucket

isValidationError

public boolean isValidationError()

Returns true if this error is a validation error in the sense that it was added to the error manager during the invocation of the validation handlers. Returns false otherwise.

getErrorInfos

public List<AWErrorInfo> getErrorInfos(Boolean validationErrors)

Description copied from interface: AWErrorBucket

Returns a list of all the error infos in this that satisfy the condition isValidationError() == validationErrors. All error infos are returned if validationErrors == null.

Specified by:

getErrorInfos in interface AWErrorBucket

setValidationError

public void setValidationError(boolean value)

Sets whether or not this is a validation error. See isValidationError().

getKey

public Object getKey()

Specified by:

getKey in interface AWErrorBucket

getKeys

public Object[] getKeys()

Specified by:

getKeys in interface AWErrorBucket

getMessage

public String getMessage()

getErrantValue

public Object getErrantValue()

getValueSource

public Object getValueSource()

getGroupName

public Object getGroupName()

getFieldPath

public Object getFieldPath()

getErrorSource

public Object getErrorSource()

setErrorSource

public void setErrorSource(Object source)

keysEqual

public boolean keysEqual(Object[] theirKeys)

Specified by:

keysEqual in interface AWErrorBucket

keysEqualLoosely

public boolean keysEqualLoosely(Object[] theirKeys)

isSameError

public boolean isSameError(AWErrorInfo error)

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(Logger log)

getKeysAsString

public String getKeysAsString()

getKeysAsString

public static String getKeysAsString(Object[] keys)

incrementDuplicateCount

public void incrementDuplicateCount()

decrementDuplicateCount

public void decrementDuplicateCount()

getDuplicateCount

public int getDuplicateCount()

isSingleErrorBucket

public boolean isSingleErrorBucket()

Specified by:

isSingleErrorBucket in interface AWErrorBucket

add

public AWErrorBucket add(AWErrorInfo error)

Specified by:

add in interface AWErrorBucket

isDuplicateError

public boolean isDuplicateError(AWErrorInfo error)

Specified by:

isDuplicateError in interface AWErrorBucket

hasErrorsWithSeverity

public boolean hasErrorsWithSeverity(Boolean isWarning)

Specified by:

hasErrorsWithSeverity in interface AWErrorBucket

getFirstError

public AWErrorInfo getFirstError(Boolean isWarning)

Specified by:

getFirstError in interface AWErrorBucket

get

public AWErrorInfo get(int i)

Specified by:

get in interface AWErrorBucket

size

public int size()

Specified by:

size in interface AWErrorBucket

getErrorInfos

public List<AWErrorInfo> getErrorInfos()

Description copied from interface: AWErrorBucket

Returns a list of all the AWErrorInfos in this.

Specified by:

getErrorInfos in interface AWErrorBucket

hasDuplicate

public boolean hasDuplicate()

Specified by:

hasDuplicate in interface AWErrorBucket

getAssociatedTableItem

public Object getAssociatedTableItem()

Specified by:

getAssociatedTableItem in interface AWErrorBucket

getAssociatedDataTable

public AWComponent getAssociatedDataTable()

Specified by:

getAssociatedDataTable in interface AWErrorBucket

setAssociatedTableItem

public void setAssociatedTableItem(AWComponent table,
                                   Object item)

Specified by:

setAssociatedTableItem in interface AWErrorBucket

getIndicatorId

public AWEncodedString getIndicatorId()

setIndicatorId

public void setIndicatorId(AWEncodedString id)

getWasAutoScrolled

public boolean getWasAutoScrolled()

setWasAutoScrolled

public void setWasAutoScrolled(boolean scrolled)