Package org.kuali.rice.kew.rule.bo

Class RuleTemplateBo

java.lang.Object
org.kuali.rice.krad.bo.BusinessObjectBase
org.kuali.rice.krad.bo.PersistableBusinessObjectBase
org.kuali.rice.kew.rule.bo.RuleTemplateBo
All Implemented Interfaces:
Serializable, Cloneable, org.apache.ojb.broker.PersistenceBrokerAware, org.eclipse.persistence.descriptors.changetracking.ChangeTracker, org.eclipse.persistence.internal.descriptors.PersistenceEntity, org.eclipse.persistence.internal.descriptors.PersistenceObject, org.eclipse.persistence.internal.weaving.PersistenceWeaved, org.eclipse.persistence.internal.weaving.PersistenceWeavedChangeTracking, org.eclipse.persistence.internal.weaving.PersistenceWeavedFetchGroups, org.eclipse.persistence.internal.weaving.PersistenceWeavedRest, org.eclipse.persistence.queries.FetchGroupTracker, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.kew.api.rule.RuleTemplateContract, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject
@Entity public class RuleTemplateBo extends org.kuali.rice.krad.bo.PersistableBusinessObjectBase implements org.kuali.rice.kew.api.rule.RuleTemplateContract
A model bean which represents a template upon which a rule is created. The RuleTemplate is essentially a collection of RuleAttributes (associated vai the RuleTemplateAttributeBo bean).
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Field Details

    • DEFAULT_OPTION_KEYS

      public static final String[] DEFAULT_OPTION_KEYS
      A list of default rule template option keys.

  • Constructor Details

    • RuleTemplateBo

      public RuleTemplateBo()

  • Method Details

    • removeNonDefaultOptions

      public void removeNonDefaultOptions()
      Removes any non-default rule template options on the template

    • getDelegateTemplateName

      public String getDelegateTemplateName()

    • getRuleTemplateActionsUrl

      public String getRuleTemplateActionsUrl()

    • getRuleTemplateAttribute

      public RuleTemplateAttributeBo getRuleTemplateAttribute(RuleTemplateAttributeBo ruleTemplateAttribute)

    • containsActiveRuleTemplateAttribute

      public boolean containsActiveRuleTemplateAttribute(RuleTemplateAttributeBo templateAttribute)

    • containsRuleTemplateAttribute

      public boolean containsRuleTemplateAttribute(RuleTemplateAttributeBo templateAttribute)

    • getRuleTemplateAttribute

      public RuleTemplateAttributeBo getRuleTemplateAttribute(int index)

    • getRuleTemplateAttributes

      public List<RuleTemplateAttributeBo> getRuleTemplateAttributes()
      Specified by:
      getRuleTemplateAttributes in interface org.kuali.rice.kew.api.rule.RuleTemplateContract

    • getActiveRuleTemplateAttributes

      public List<RuleTemplateAttributeBo> getActiveRuleTemplateAttributes()
      Returns a List of only the active RuleTemplateAttributes on the RuleTemplate sorted according to display order (ascending).
      Returns:

    • setActiveRuleTemplateAttributes

      public void setActiveRuleTemplateAttributes(List<RuleTemplateAttributeBo> ruleTemplateAttributes)
      This is implemented to allow us to use this collection on the inquiry for RuleTemplate. In the KNS code it does an explicit check that the property is writable.

    • setRuleTemplateAttributes

      public void setRuleTemplateAttributes(List<RuleTemplateAttributeBo> ruleTemplateAttributes)

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface org.kuali.rice.kew.api.rule.RuleTemplateContract

    • setDescription

      public void setDescription(String description)

    • getName

      public String getName()
      Specified by:
      getName in interface org.kuali.rice.kew.api.rule.RuleTemplateContract

    • setName

      public void setName(String name)

    • getId

      public String getId()
      Specified by:
      getId in interface org.kuali.rice.core.api.mo.common.Identifiable

    • setId

      public void setId(String id)

    • getDelegationTemplateId

      public String getDelegationTemplateId()

    • setDelegationTemplateId

      public void setDelegationTemplateId(String delegationTemplateId)

    • getDelegationTemplate

      public RuleTemplateBo getDelegationTemplate()
      Specified by:
      getDelegationTemplate in interface org.kuali.rice.kew.api.rule.RuleTemplateContract

    • setDelegationTemplate

      public void setDelegationTemplate(RuleTemplateBo delegationTemplate)

    • getReturnUrl

      public String getReturnUrl()

    • setReturnUrl

      public void setReturnUrl(String returnUrl)

    • getEncodedName

      public String getEncodedName()
      Used from the rule quicklinks when doing the focus channel.

    • getRuleTemplateOptions

      public List<RuleTemplateOptionBo> getRuleTemplateOptions()
      Specified by:
      getRuleTemplateOptions in interface org.kuali.rice.kew.api.rule.RuleTemplateContract

    • setRuleTemplateOptions

      public void setRuleTemplateOptions(List<RuleTemplateOptionBo> ruleTemplateOptions)

    • getRuleTemplateOption

      public RuleTemplateOptionBo getRuleTemplateOption(String key)

    • setAcknowledge

      public void setAcknowledge(RuleTemplateOptionBo acknowledge)

    • setComplete

      public void setComplete(RuleTemplateOptionBo complete)

    • setApprove

      public void setApprove(RuleTemplateOptionBo approve)

    • setFyi

      public void setFyi(RuleTemplateOptionBo fyi)

    • setDefaultActionRequestValue

      public void setDefaultActionRequestValue(RuleTemplateOptionBo defaultActionRequestValue)

    • getAcknowledge

      public RuleTemplateOptionBo getAcknowledge()

    • getComplete

      public RuleTemplateOptionBo getComplete()

    • getApprove

      public RuleTemplateOptionBo getApprove()

    • getFyi

      public RuleTemplateOptionBo getFyi()

    • getDefaultActionRequestValue

      public RuleTemplateOptionBo getDefaultActionRequestValue()

    • getRoles

      public List<org.kuali.rice.kew.api.rule.RoleName> getRoles()
      Returns a List of Roles from all RoleAttributes attached to this template.
      Returns:
      list of roles

    • to

      public static org.kuali.rice.kew.api.rule.RuleTemplate to(RuleTemplateBo bo)