org.openemcee.microflow.usercore
Interface PermissionedDataValidator

public interface PermissionedDataValidator

The permissioned data validator interface is used to provide data validation to data in a Microflow. For more information, please see our tutorial "Intro to Microflow Validators" on our homepage.

Author:

Scott Schenkein

Field Summary

static java.lang.String

VCS_ID Version control tag.

Method Summary

boolean	setParameters(MicroflowParameters params) Will always be called prior to the first validate.
boolean	validate(java.lang.Object obj) This method is called after a task executes, any time that validated, permissioned data is accessed or modified.

Field Detail

VCS_ID

public static final java.lang.String VCS_ID

Version control tag.

See Also:

Constant Field Values

Method Detail

validate

public boolean validate(java.lang.Object obj)

This method is called after a task executes, any time that validated, permissioned data is accessed or modified. setParameters() will always be called successfully prior to calling the validate method. If setParameters() fails, this method will never be called. This method will be called once or more in the lifetime of the object. Note that if not this method is not reentrant, you must make it must make validate method "synchronized".

Parameters:

obj - This is the target object which we are going to validate. It is guaranteed to be of the same type (or narrower) as that which is define in the data permissions section of the Microflow job descriptor.

Returns:

True on successful validation, false on unsuccessful validation.

setParameters

public boolean setParameters(MicroflowParameters params)

Will always be called prior to the first validate.

Parameters:

params - The parameters which were configure for this validator in the XML.

Returns:

Returns true on successs, false on failure.