wt.rule
Interface RuleApplier

All Known Implementing Classes:

DefaultRuleApplier, EPMDocumentCopyRuleApplier, LifeCycleManagedInitRuleApplier, TypeBasedInitRuleApplier, WTDocumentCopyRuleApplier, WTDocumentInitRuleApplier, WTPartCopyRuleApplier, WTPartInitRuleApplier

public interface RuleApplier

This interface specifies an applier of a rule. An instance of this class applies a rule to an object. The results of applying a rule to an object depends on the type of rule being applied.

Supported API: false

Extendable: false

Method Summary

Object

applyRule(Object object, Rule rule, WTContainerRef container) Apply rule to the object.

Method Detail

applyRule

public Object applyRule(Object object,
                        Rule rule,
                        WTContainerRef container)
                 throws WTException,
                        WTPropertyVetoException

Apply rule to the object. Return the resulting object. The specified container is used to lookup resource objects that are required while applying the rule. The result object might be the same object or a different one depending on the semantics of the rule.

If the rule is null, or the rule does not have a specification, then nothing is done and the original object is returned (i.e., a no-op is performed).

Different implementations of this interface will handle rule application differently.

Parameters:

object - the object that the rule should be applied to (cannot be null)

rule - the rule to be applied

container - the container to use for resource object lookups

Returns:

Object

Throws:

WTException

WTPropertyVetoException