biz.c24.io.api.data
Class SimpleValidator

java.lang.Object
  extended by biz.c24.io.api.data.SimpleValidator
All Implemented Interfaces:
Enumeration, ModelComponent, ValidationRule, Validator, Serializable

public class SimpleValidator
extends Object
implements Validator, Enumeration, ValidationRule

Validator implementation which will always pass or fail validation depending on the value of a System property.

Warning: Serialized objects of this class or of a deployed class which is derived from it may not be compatible with future releases of C24 Integreation Objects. The current serialization support is appropriate for short term storage or RMI between applications running the same version of C24 Integreation Objects.

See Also:
Serialized Form

Field Summary
static String PASS_WITHOUT_RESOURCE
          Deprecated. Use Utils.SYSTEM_PROPERTY_PASS_VALIDATION_WITHOUT_RESOURCE instead.
 
Method Summary
 Annotation getAnnotation()
          Returns the annotation associated with this enumeration.
 Annotation getAnnotation(int index)
          Returns the annotation associated with the enumeration value at index.
 int getCount()
          Returns the number of enumeration values.
 String getDependentPredicateCode(int index)
          Returns the dependent predicate code at index.
 int getDependentPredicateCodeCount()
          Returns the number of dependent predicate codes associated with this rule.
 String getErrorCode()
          Returns the error code for this enumeration.
 int getIndex(String value)
          Returns the first index of value or -1 if it was not found.
static SimpleValidator getInstance()
          Singleton method to return the static instance.
 String getName()
          Returns the name of this component.
 String getName(int index)
          Returns the name associated with the enumeration value at index.
 String getPredicateCode()
          Returns the predicate code associated with this rule.
 ValidationSeverityEnum getSeverity()
          Returns the severity of this rule.
 String getValue(int index)
          Returns the enumeration value at index.
 boolean validate(Object object, DataComponent component, ComplexDataObject context, ValidationManager manager)
          Validate the given object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PASS_WITHOUT_RESOURCE

public static final String PASS_WITHOUT_RESOURCE
Deprecated. Use Utils.SYSTEM_PROPERTY_PASS_VALIDATION_WITHOUT_RESOURCE instead.
The System property key used to determine the behaviour of this class when a required resource is not available.

See Also:
Constant Field Values
Method Detail

getInstance

public static SimpleValidator getInstance()
Singleton method to return the static instance.

Returns:
The validator.

getAnnotation

public Annotation getAnnotation()
Description copied from interface: Enumeration
Returns the annotation associated with this enumeration.

Specified by:
getAnnotation in interface Enumeration
Specified by:
getAnnotation in interface ValidationRule
Returns:
The annotation

getName

public String getName()
Description copied from interface: ModelComponent
Returns the name of this component.

Specified by:
getName in interface ModelComponent
Returns:
The name.

getSeverity

public ValidationSeverityEnum getSeverity()
Description copied from interface: ValidationRule
Returns the severity of this rule.

Specified by:
getSeverity in interface ValidationRule
Returns:
The severity.

getErrorCode

public String getErrorCode()
Description copied from interface: Enumeration
Returns the error code for this enumeration.

Specified by:
getErrorCode in interface Enumeration
Specified by:
getErrorCode in interface ValidationRule
Returns:
The error code.

getPredicateCode

public String getPredicateCode()
Description copied from interface: ValidationRule
Returns the predicate code associated with this rule.

Specified by:
getPredicateCode in interface ValidationRule
Returns:
The predicate code.

getDependentPredicateCodeCount

public int getDependentPredicateCodeCount()
Description copied from interface: ValidationRule
Returns the number of dependent predicate codes associated with this rule.

Specified by:
getDependentPredicateCodeCount in interface ValidationRule
Returns:
The count.

getDependentPredicateCode

public String getDependentPredicateCode(int index)
Description copied from interface: ValidationRule
Returns the dependent predicate code at index.

Specified by:
getDependentPredicateCode in interface ValidationRule
Parameters:
index - the index of the code to return.
Returns:
The code.

getCount

public int getCount()
Description copied from interface: Enumeration
Returns the number of enumeration values.

Specified by:
getCount in interface Enumeration
Returns:
The number of values.

getIndex

public int getIndex(String value)
Description copied from interface: Enumeration
Returns the first index of value or -1 if it was not found.

Specified by:
getIndex in interface Enumeration
Parameters:
value - The value to look for.
Returns:
The index of the first occurance of value or -1 if it was not found.

getValue

public String getValue(int index)
Description copied from interface: Enumeration
Returns the enumeration value at index.

Specified by:
getValue in interface Enumeration
Parameters:
index - The index of the value to return.
Returns:
The value at index.

getName

public String getName(int index)
Description copied from interface: Enumeration
Returns the name associated with the enumeration value at index.

Specified by:
getName in interface Enumeration
Parameters:
index - The index of the name to return.
Returns:
The name at index.

getAnnotation

public Annotation getAnnotation(int index)
Description copied from interface: Enumeration
Returns the annotation associated with the enumeration value at index.

Specified by:
getAnnotation in interface Enumeration
Parameters:
index - The index of the annotation to return.
Returns:
The name at index.

validate

public boolean validate(Object object,
                        DataComponent component,
                        ComplexDataObject context,
                        ValidationManager manager)
                 throws ValidationException
Description copied from interface: Validator
Validate the given object.

Specified by:
validate in interface Validator
Parameters:
object - The object to be validated - commonly a String, Integer, Double, Date etc.
component - The Element or Attribute inside context which defines object.
context - The parent of object - could be null.
manager - The validation manager which is performing this validation.
Returns:
Whether the object is valid if the validation manager is not operating in exception mode.
Throws:
ValidationException - If the object is not valid and the validation maanger is operating in exception mode.


C24 Technologies © 2002-2012: All Rights Reserved.