com.aspc.DBObj.Errors

Class ValidationList

java.lang.Object

com.aspc.DBObj.Errors.ValidationList

public class ValidationList
extends java.lang.Object

ValidationList is a
THREAD MODE: SINGLE-THREADED

Since:

August 15, 2001, 11:07 AM

Author:

Jason McGrath

Constructor Summary

Constructors

Constructor and Description
ValidationList(DataSource ds)

Method Summary

Modifier and Type	Method and Description
ValidationList	add(DBAccessException ae)
ValidationList	add(ValidationItem item) THREAD SAFE
ValidationError	createError(DBObject targetObject, DBField field, java.lang.String simpleMsg) Short hand method to create a validation error.
ValidationError	createError(DBObject targetObject, DBField field, java.lang.Throwable e) Short hand method to create a validation error.
ValidationError	createError(java.lang.String msgID, DBObject targetObject, DBField field) Short hand method to create a validation error.
ValidationError	createError(java.lang.String msgID, DBObject targetObject, DBField field, java.lang.Object... args) Short hand method to create a validation error.
ValidationReasonRequired	createValidationReasonRequired(DBObject targetObject, java.lang.String simpleMsg)
ValidationWarning	createWarning(DBObject targetObject, java.lang.String simpleMsg)
ValidationWarning	createWarning(java.lang.String msgID, DBObject targetObject, DBField field) Short hand method to create a validation error.
ValidationWarning	createWarning(java.lang.String msgID, DBObject targetObject, DBField field, java.lang.Object arg)
ValidationWarning	createWarning(java.lang.String msgID, DBObject targetObject, java.lang.Object... args)
ValidationItem	get(int pos)
DataSource	getDS()
int	getErrorCount()
ValidationItem	getItem(java.lang.String msgID) Returns the first validation item that matches the supplied msgId
ValidationItem	getWorstItem()
boolean	hasErrors()
boolean	hasFieldChangeMessage()
boolean	hasWarnings()
ValidationItem[]	listItems()
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationList

public ValidationList(@Nonnull
                      DataSource ds)

Parameters:

ds - the data source

Method Detail

getDS

@CheckReturnValue
 @Nonnull
public DataSource getDS()

Returns:

the value

createError

@Nonnull
public ValidationError createError(@Nullable
                                            DBObject targetObject,
                                            @Nullable
                                            DBField field,
                                            @Nullable
                                            java.lang.String simpleMsg)

Short hand method to create a validation error.

Parameters:

targetObject - The DBObject that is in error

field - The field in error

simpleMsg - A simple validation message

Returns:

The validation error.

createError

@Nonnull
public ValidationError createError(@Nullable
                                            DBObject targetObject,
                                            @Nullable
                                            DBField field,
                                            @Nonnull
                                            java.lang.Throwable e)

Short hand method to create a validation error.

Parameters:

targetObject - The DBObject that is in error

field - The field in error

e - the exception

Returns:

The validation error.

createError

@Nonnull
public ValidationError createError(java.lang.String msgID,
                                            DBObject targetObject,
                                            DBField field)

Short hand method to create a validation error.

Parameters:

msgID - The message ID to use

targetObject - The DBObject that is in error

field - The field in error

Returns:

The validation error.

createError

@Nonnull
public ValidationError createError(@Nonnull
                                            java.lang.String msgID,
                                            @Nullable
                                            DBObject targetObject,
                                            @Nullable
                                            DBField field,
                                            @Nullable
                                            java.lang.Object... args)

Short hand method to create a validation error.

Parameters:

msgID - The message ID to use

targetObject - The DBObject that is in error

field - The field in error

args - argument for message parameters.

Returns:

The validation error.

createWarning

@Nonnull
public ValidationWarning createWarning(DBObject targetObject,
                                                java.lang.String simpleMsg)

Parameters:

targetObject -

simpleMsg -

Returns:

the value

createWarning

@Nonnull
public ValidationWarning createWarning(java.lang.String msgID,
                                                DBObject targetObject,
                                                DBField field)

Short hand method to create a validation error.

Parameters:

msgID - The message ID to use

targetObject - The DBObject that is in error

field - The field in error

Returns:

The validation error.

createWarning

@Nonnull
public ValidationWarning createWarning(java.lang.String msgID,
                                                DBObject targetObject,
                                                DBField field,
                                                java.lang.Object arg)

createWarning

@Nonnull
public ValidationWarning createWarning(java.lang.String msgID,
                                                DBObject targetObject,
                                                java.lang.Object... args)

createValidationReasonRequired

@Nonnull
public ValidationReasonRequired createValidationReasonRequired(@Nullable
                                                                        DBObject targetObject,
                                                                        @Nullable
                                                                        java.lang.String simpleMsg)

Parameters:

targetObject -

simpleMsg -

Returns:

the value

size

@CheckReturnValue
 @Nonnegative
public int size()

Returns:

the value

get

@CheckReturnValue
 @Nonnull
public ValidationItem get(@Nonnegative
                                                      int pos)

Parameters:

pos -

Returns:

the value

add

@Nonnull
public ValidationList add(@Nonnull
                                   DBAccessException ae)

Parameters:

ae -

Returns:

this

add

@Nonnull
public ValidationList add(@Nonnull
                                   ValidationItem item)

THREAD SAFE

Parameters:

item -

Returns:

this

listItems

@CheckReturnValue
 @Nonnull
public ValidationItem[] listItems()

Returns:

the value

getWorstItem

@CheckReturnValue
 @Nullable
public ValidationItem getWorstItem()

Returns:

the value

getItem

@CheckReturnValue
 @Nullable
public ValidationItem getItem(@Nullable
                                                           java.lang.String msgID)

Returns the first validation item that matches the supplied msgId

Parameters:

msgID - - The message id used for the search

Returns:

- Validation item that has the supplied msgID or null if none where found

getErrorCount

@CheckReturnValue
 @Nonnegative
public int getErrorCount()

Returns:

the value

hasErrors

@CheckReturnValue
public boolean hasErrors()

Returns:

the value

hasFieldChangeMessage

@CheckReturnValue
public boolean hasFieldChangeMessage()

Returns:

the value

hasWarnings

@CheckReturnValue
public boolean hasWarnings()

Returns:

the value