com.ibm.pim.interfaces.validation
Interface ValidationErrors


public interface ValidationErrors

Read-only interface providing static ValidationError methods


Field Summary
static java.lang.String copyright
           
 
Method Summary
 int getGlobalErrorCount()
          Returns the number of global errors
 GlobalValidationError getGlobalErrorForAttribute(java.lang.String path)
          Returns the validation errors for a global attribute with a given path
 GlobalValidationError[] getGlobalErrors()
          Returns the validation errors for all global attributes
 int getLocationErrorCount()
          Returns the number of location attribute errors
 LocationValidationError getLocationErrorForAttribute(Category location, java.lang.String path)
          Returns the location validation error for an attribute with a given category and path
 LocationValidationError[] getLocationErrors()
          Returns the validation errors for all location attributes
 int getTotalErrorCount()
          Returns the total error count
 boolean hasErrors()
          Returns true if there are errors, otherwise false
 boolean hasGlobalErrors()
          Returns true if there are global attribute errors, otherwise false
 boolean hasLocationErrors()
          Returns true if there are Location attribute errors, otherwise false
 

Field Detail

copyright

public static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

hasErrors

public boolean hasErrors()
                  throws PIMInternalException
Returns true if there are errors, otherwise false

Returns:
true if there are errors, otherwise false
Throws:
PIMInternalException - If an internal error occurs

hasLocationErrors

public boolean hasLocationErrors()
                          throws PIMInternalException
Returns true if there are Location attribute errors, otherwise false

Returns:
true if there are Location attribute errors, otherwise false
Throws:
PIMInternalException - If an internal error occurs

hasGlobalErrors

public boolean hasGlobalErrors()
                        throws PIMInternalException
Returns true if there are global attribute errors, otherwise false

Returns:
true if there are global attribute errors, otherwise false
Throws:
PIMInternalException - If an internal error occurs

getTotalErrorCount

public int getTotalErrorCount()
                       throws PIMInternalException
Returns the total error count

Returns:
an integer holding the total error count
Throws:
PIMInternalException - If an internal error occurs

getGlobalErrorCount

public int getGlobalErrorCount()
                        throws PIMInternalException
Returns the number of global errors

Returns:
an integer holding the number of global errors
Throws:
PIMInternalException - If an internal error occurs

getLocationErrorCount

public int getLocationErrorCount()
                          throws PIMInternalException
Returns the number of location attribute errors

Returns:
an integer holding the number of location attribute errors
Throws:
PIMInternalException - If an internal error occurs

getGlobalErrorForAttribute

public GlobalValidationError getGlobalErrorForAttribute(java.lang.String path)
                                                 throws PIMInternalException
Returns the validation errors for a global attribute with a given path

Parameters:
path - the path of the attribute to check for errors
Returns:
a GlobalValidationError object for errors on the given path, or null
Throws:
PIMInternalException - If an internal error occurs

getGlobalErrors

public GlobalValidationError[] getGlobalErrors()
                                        throws PIMInternalException
Returns the validation errors for all global attributes

Returns:
an array of GlobalValidationErrors
Throws:
PIMInternalException - If an internal error occurs

getLocationErrorForAttribute

public LocationValidationError getLocationErrorForAttribute(Category location,
                                                            java.lang.String path)
                                                     throws PIMInternalException
Returns the location validation error for an attribute with a given category and path

Parameters:
location - the Category to look within
path - the path of the attribute to check
Returns:
a LocationValidationError object for errors on the given path, or null
Throws:
PIMInternalException - If an internal error occurs

getLocationErrors

public LocationValidationError[] getLocationErrors()
                                            throws PIMInternalException
Returns the validation errors for all location attributes

Returns:
An array of LocationValidationErrors
Throws:
PIMInternalException - If an internal error occurs