BaseValidationTask

BaseValidationTask

Kind: global class

• BaseValidationTask
  • new BaseValidationTask(pluginName, context)
  • .addRuleComponentMetadata()
  • .addValidationStep(messageText, validate)
  • .validate() ⇒
  • .addValidationResult(messageText, isValid, options)

new BaseValidationTask(pluginName, context)

Creates a new instance of a validation Task.

Param	Description
pluginName	The name of the plugin this task is included in.
context	The runtime task context passed to the Task.

baseValidationTask.addRuleComponentMetadata()

Adds componennt data to the rule metadata.

Kind: instance method of BaseValidationTask

baseValidationTask.addValidationStep(messageText, validate)

Adds a validation step to be run during this class' validate method.

Kind: instance method of BaseValidationTask

Param	Type	Description
messageText		A non-empty string containing a plain text message
validate	ValidationResult	A function to run that returns a indicating whether the validation was successful.

baseValidationTask.validate() ⇒

Validates each step added by addValidationStep.

Kind: instance method of BaseValidationTask
Returns: A map of messages and ValidationResult objects

baseValidationTask.addValidationResult(messageText, isValid, options)

Adds a validation-specific result object to the Checkup output. '

Kind: instance method of BaseValidationTask

Param	Description
messageText	A non-empty string containing a plain text message
isValid	A boolean indicating whether the validation step is valid.
options	Additional options to pass to the result
options.location	Specifies a location where the result occurred
options.properties	A property bag named properties, which stores additional values on the result