org.eclipse.actf.validation.core
Interface IValidationProcess

All Known Implementing Classes:
AbstractValidationProcess, AccessibilityValidationProcess, FocusValidationProcess

public interface IValidationProcess

represents a single validation process triggered by an execution point. A validation process controls the initiation of a validation of content or a running application and how validation proceeds as the content or application is used. The ValidationProcessManager is responsible for launching all processes as execution points are encountered.

Author:
Mike Squillace
See Also:
ExecutionPoint, ValidationProcessManager

Method Summary
 ExecutionPoint getExecutionPoint()
          returns the ExecutionPoint triggering this IValidationProcess.
 int getProgress()
          returns the approximate progress relative to the amount of estimated work as an integer percentage.
 IRuleBase getRuleBase()
          returns the IRuleBase used in this IValidationProcess.
 IValidationContext getValidationContext()
          returns the IValidationContext used in this IValidationProcess.
 int getWorkEstimate()
          returns an estimate on the amount of work required by this process.
 void init()
          perform any initialization necessary for the process.
 void run()
          launch the validation process
 void setExecutionPoint(ExecutionPoint execPoint)
          sets the ExecutionPoint used in this IValidationProcess.
 void setRuleBase(IRuleBase rulebase)
          sets the IRuleBase used in this IValidationProcess.
 void setValidationContext(IValidationContext context)
          sets the IValidationContext used in this IValidationProcess.
 

Method Detail

init

void init()
          throws ValidationProcessException
perform any initialization necessary for the process. For example, some implementations of this interface try to estimate the work in this method.

Throws:
ValidationProcessException

run

void run()
         throws ValidationProcessException
launch the validation process

Throws:
ValidationProcessException

getWorkEstimate

int getWorkEstimate()
returns an estimate on the amount of work required by this process. Returning -1 means that no work estimate is available or that this process does not plan to support any sort of progress indication.

Returns:
estimate of work required by this process or-1 if not supported or not available

getProgress

int getProgress()
returns the approximate progress relative to the amount of estimated work as an integer percentage. Returning a 0 means that a work estimate is available but there is no progress as of yet. Returning -1 means that no work estimate is available or that this process does not plan to support any sort of progress indication.

Returns:
the current progress as a percentage of the estimated work, 0 if no progress has been make or-1 if not supported or not available

getRuleBase

IRuleBase getRuleBase()
returns the IRuleBase used in this IValidationProcess.

Returns:
the IRuleBase for this IValidationProcess

getExecutionPoint

ExecutionPoint getExecutionPoint()
returns the ExecutionPoint triggering this IValidationProcess.

Returns:
the ExecutionPoint for this IValidationProcess

getValidationContext

IValidationContext getValidationContext()
returns the IValidationContext used in this IValidationProcess.

Returns:
the IValidationContext for this IValidationProcess

setRuleBase

void setRuleBase(IRuleBase rulebase)
sets the IRuleBase used in this IValidationProcess.

Parameters:
rulebase - -- the IRuleBase for this IValidationProcess

setExecutionPoint

void setExecutionPoint(ExecutionPoint execPoint)
sets the ExecutionPoint used in this IValidationProcess.

Parameters:
execPoint - -- the ExecutionPoint for this IValidationProcess

setValidationContext

void setValidationContext(IValidationContext context)
sets the IValidationContext used in this IValidationProcess.

Parameters:
context - -- the IValidationContext for this IValidationProcess