Package wt.rule.algorithm

Interface RuleAlgorithm

All Known Implementing Classes:
AdminDomainAttributeAlgorithm, AndTest, BooleanBranch, BooleanConstant, CaseBranch, com.ptc.core.foundation.lifecycle.server.impl.DiscreteLifecycleTemplateSetAlgorithm, DiscreteLifecycleTemplateSetAlogrithm, com.ptc.core.foundation.team.server.impl.DiscreteTeamTemplateSetAlgorithm, DiscreteTeamTemplateSetAlogrithm, EnumTypeConstant, EqualsTest, FolderPathAttributeAlgorithm, GatherAttributeConstraints, GetDefaultContent, GetDiscreteSetConstraint, GetHiddenConstraint, GetImmutableConstraint, GetNullValue, GetServerAssignedConstraint, GetServerPreGeneratedValue, IfContainerTypeEqualsProjectTest, IfNotNullTest, IfNullTest, LifeCycleTemplateAttributeAlgorithm, NumberGenerator, OrgNameEqualsTest, OrgNameInListTest, OrTest, OwningOrgDefaultAlgorithm, PersonOrPlaceAlternatedIdentifierRuleAlgorithm, StringConstant, StringEqualsTest, StringInListTest, StringRegExEqualsTest, TeamTemplateAttributeAlgorithm, VariantNameGenerator, VersionInfoGenerator, ViewAttributeAlgorithm
public interface RuleAlgorithm
Code that implements this interface could allow itself to be used within the Rule xml files defined through administrative OIR as algorithms. An algorithm that can be used to compute a value based on a set of String arguments. OOTB rule algorithms could be used to set default value of an attribute, or specifying certain display characteristics of an attribute or both. Additionally there are conditional logic algorithms written OOTB for checking if certain conditions are met before setting the value. The evaluation of the condition requires the conditional attribute be set beforehand. The RuleAlgorithm interface is supported in Windchill X10 release. Customer could write code which implements this interface to add new additional customer algorithms for setting default values, defining attribute display constraints, or conditional logics to fit their specific needs.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    calculate(Object[] args, WTContainerRef container)
    Execute the algorithm using the specified arguments.

  • Method Details

    • calculate

      Object calculate(Object[] args, WTContainerRef container) throws WTException
      Execute the algorithm using the specified arguments. Return the result.

      Supported API: true
      Parameters:
      args - the arguments for the algorithm
      container - the container to use for object lookups
      Returns:
      Object
      Throws:
      WTException