Package com.appiancorp.suiteapi.personalization

Class RuleSet

java.lang.Object
com.appiancorp.suiteapi.personalization.RuleSet
All Implemented Interfaces:
Serializable
public class RuleSet extends Object implements Serializable

Title: RuleForm

Description: This is the form used to create a group membership ruleset.

Copyright: Copyright (c) 2002

Company: Appian Corporation

See Also:

  • Constructor Details

    • RuleSet

      public RuleSet()
      Default no-arg constructor.

    • RuleSet

      public RuleSet(Long groupId, Expression[] expressions)
      Constructor that receives a group id for this rule set and a list of expressions.
      Parameters:
      groupId - The id of the group to which this rule set belongs.
      expressions - List of expressions to use in this rule set.

  • Method Details

    • setRuleName

      public void setRuleName(String rnm)
      Sets the name of the rule set.
      Parameters:
      rnm - Name of the rule set.

    • getRuleName

      public String getRuleName()
      Gets the name of the rule set.
      Returns:
      Name of the rule set.

    • setGroupId

      public void setGroupId(Long gid)
      Sets the Id of the group to which this rule set will belong.
      Parameters:
      gid - Id of the group of this rule set.

    • getGroupId

      public Long getGroupId()
      Gets the Id of the group of this rule set belongs.
      Returns:
      Id of the group of this rule set.

    • setRuleDescription

      public void setRuleDescription(String rdesc)
      Sets the description of this rule set.
      Parameters:
      rdesc - Description of the rule set.

    • getRuleDescription

      public String getRuleDescription()
      Gets the description of this rule set.
      Returns:
      Description of this rule set.

    • setEntityType

      public void setEntityType(String entityType)
      Sets the entity type of this rule set.
      Parameters:
      entityType - Entity type for this rule set.

    • getEntityType

      public String getEntityType()
      Gets the entity type of this rule set.
      Returns:
      Entity type of this rule set.

    • setGroupTypeId

      public void setGroupTypeId(String groupTypeId)
      Sets string representation of types of expressions in the rule set.
      Parameters:
      groupTypeId -
      See Also:

    • getGroupTypeId

      public String getGroupTypeId()
      This field is used to temporarily store the types of expressions contained in this rule set (user or group).
      Returns:
      String representation of types of expressions used.

    • setConditions

      public void setConditions(String conditions)
      Sets a string representation of the conditions to use in the rule set.
      Parameters:
      conditions - Conditions to use.
      See Also:

    • getConditions

      public String getConditions()
      Returns the string representation of the conditions used in this rule set. The conditions of this rule set however are stored as Condition objects within the list of Expression.
      Returns:
      String representation of defined conditions.

    • setExpressions

      public void setExpressions(Expression[] expressions)
      Sets the list of expressions for this rule set.
      Parameters:
      expressions - List of expressions to use.

    • getExpressions

      public Expression[] getExpressions()
      Gets the list of expressions used in this rule set.
      Returns:
      List of expressions used.

    • toString

      public String toString()
      Creates a string representation of the RuleSet (does not contain all fields).
      Overrides:
      toString in class Object
      Returns:
      String representation of the rule set.