org.pentaho.di.imp.rule

Interface ImportRuleInterface

All Superinterfaces:

Cloneable

All Known Implementing Classes:

BaseImportRule, DatabaseConfigurationImportRule, JobHasANoteImportRule, JobHasDescriptionImportRule, JobHasJobLogConfiguredImportRule, JobHasNoDisabledHopsImportRule, TransformationHasANoteImportRule, TransformationHasDescriptionImportRule, TransformationHasNoDisabledHopsImportRule, TransformationHasTransLogConfiguredImportRule

public interface ImportRuleInterface
extends Cloneable

Method Summary

Modifier and Type	Method and Description
ImportRuleInterface	clone()
String	getCompositeClassName()
String	getId()
String	getXML()
boolean	isEnabled()
boolean	isUnique()
void	loadXML(Node ruleNode)
void	setEnabled(boolean enabled)
void	setId(String string)
List<ImportValidationFeedback>	verifyRule(Object subject) Validate the rule against a subject (transformation, job, database, ...)

Method Detail

getId

String getId()

Returns:

The import rule plugin ID

setId

void setId(String string)

Parameters:

string - Sets the plugin ID of this import rule

verifyRule

List<ImportValidationFeedback> verifyRule(Object subject)

Validate the rule against a subject (transformation, job, database, ...)

Parameters:

subject - The subject to validate against

Returns:

The feedback list consists of a series of approvals and/or warnings and/or errors.

isEnabled

boolean isEnabled()

Returns:

True if this rule is enabled. When not enabled this rule will not be looked at. Neither an approval nor an error will be given during validation.

setEnabled

void setEnabled(boolean enabled)

Parameters:

enabled - Enables or disables this rule. When a rule is not enabled it will not be looked at. Neither an approval nor an error will be given during validation.

isUnique

boolean isUnique()

Returns:

true if only one rule is needed in a whole set of rules. Adding another would not help. Returns false in case you can add this rule multiple times with different settings.

loadXML

void loadXML(Node ruleNode)
      throws org.pentaho.di.core.exception.KettleException

Throws:

org.pentaho.di.core.exception.KettleException

getXML

String getXML()

getCompositeClassName

String getCompositeClassName()

clone

ImportRuleInterface clone()