org.iscreen
Interface ValidatorMetaData

public interface ValidatorMetaData

Author:

Shellman, Dan

Method Summary

java.lang.String	getId() Retrieves the unique identification for the validator.
ValidatorMetaData	getParentMetaData() Retrieves the validator metadata for the parent (or referenced) validator of this validator.
java.lang.String	getUniquePath() Returns a unique String that represents the "path" to this validator from validation services that call this validator.
ValidationService	getValidationService() Retrieves the validation service that contains this validator.
Validator	getValidator() Retrieves the Validator that this metadata describes.
java.lang.Class	getValidatorClass() Retrieves the class of the validator.

Method Detail

getValidator

Validator getValidator()

Retrieves the Validator that this metadata describes.

Returns:

Returns the Validator this metadata describes.

getId

java.lang.String getId()

Retrieves the unique identification for the validator.

Returns:

Returns the unique id of the validator.

getValidatorClass

java.lang.Class getValidatorClass()

Retrieves the class of the validator.

Returns:

Returns the class of the validator.

getParentMetaData

ValidatorMetaData getParentMetaData()

Retrieves the validator metadata for the parent (or referenced) validator of this validator. If this validator doesn't reference another validator, then this will return null.

Returns:

Returns the parent or referenced validator metadata for this validator. If none, then this will return null.

getValidationService

ValidationService getValidationService()

Retrieves the validation service that contains this validator.

Returns:

Returns the validation service that contains this validator.

getUniquePath

java.lang.String getUniquePath()

Returns a unique String that represents the "path" to this validator from validation services that call this validator. For example, if a ValidationService calls another ValidationService which calls this Validator, then this returned path would represent that path.

Specifically, if ValidationService called "my.set.A" calls another ValidationService called "my.set.B" calls another ValidationService called "my.set.C" which calls this Validator (with an id of "my.Validator"), then this method would return the "path" as: "my.set.A|my.set.B|my.set.C|my.Validator". The delimiter between validation services and validator is the vertical bar.

Returns:

Returns the unique path from validation service to validation service to validator that represents this validator.