Package dev.jcputney.elearning.parser.input.scorm2004.ims.ss.rollup

Class RollupRule

java.lang.Object
dev.jcputney.elearning.parser.input.scorm2004.ims.ss.rollup.RollupRule
All Implemented Interfaces:
Serializable
public final class RollupRule extends Object implements Serializable
Represents an individual rollup rule within a set of rollup rules. Each rule defines conditions and an action that dictate how child activities’ statuses affect the parent activity’s rollup.
See Also:

  • Constructor Details

    • RollupRule

      public RollupRule()
      Default constructor for the RollupRule class. Initializes a new instance with no specific configuration. This constructor does not perform any operations or set any initial values for the fields within the class.

  • Method Details

    • getRollupConditions

      public RollupConditions getRollupConditions()
      Retrieves the rollup conditions associated with this instance. Rollup conditions define criteria that determine if specific rollup logic should be applied based on the status of child activities.
      Returns:
      the RollupConditions object representing the criteria for applying the rollup rule.

    • setRollupConditions

      public void setRollupConditions(RollupConditions rollupConditions)
      Sets the rollup conditions for this instance. Rollup conditions define the specific criteria that determine if rollup logic should be applied based on the status of child activities.
      Parameters:
      rollupConditions - the RollupConditions object containing the criteria for rollup processing

    • getRollupAction

      public RollupAction getRollupAction()
      Retrieves the rollup action associated with this instance. The rollup action specifies the operation to perform on the parent activity's status when the conditions defined in the rollup rule are satisfied.
      Returns:
      the RollupAction object representing the action to be performed if the rollup conditions are met.

    • setRollupAction

      public void setRollupAction(RollupAction rollupAction)
      Sets the rollup action to be performed when the conditions of the rollup rule are met. The rollup action specifies the operation to apply to the parent activity's status based on the statuses of its child activities and the associated rollup criteria.
      Parameters:
      rollupAction - the RollupAction object defining the specific action to be taken when the rollup conditions are satisfied

    • getChildActivitySet

      public ChildActivitySet getChildActivitySet()
      Retrieves the child activity set associated with this instance. The child activity set specifies the subset of child activities to consider while evaluating the rollup rule.
      Returns:
      the ChildActivitySet representing the set of child activities to be used in rollup rule evaluation.

    • setChildActivitySet

      public void setChildActivitySet(ChildActivitySet childActivitySet)
      Sets the child activity set for this instance. The child activity set specifies the subset of child activities to consider during the evaluation of the rollup rule.
      Parameters:
      childActivitySet - the ChildActivitySet representing the set of child activities to be used in rollup rule evaluation

    • getMinimumCount

      public int getMinimumCount()
      Retrieves the minimum count associated with this instance. The minimum count specifies the threshold value used in evaluating whether the rollup rule criteria are met.
      Returns:
      the minimum count as an integer.

    • setMinimumCount

      public void setMinimumCount(int minimumCount)
      Sets the minimum count for this instance. The minimum count represents the threshold value used in evaluating whether the rollup rule criteria are met.
      Parameters:
      minimumCount - the minimum count as an integer.

    • getMinimumPercent

      public PercentType getMinimumPercent()
      Retrieves the minimum percentage associated with this instance. The minimum percentage is represented as a PercentType, which holds a value constrained between 0 and 1, inclusive.
      Returns:
      the PercentType object representing the minimum percentage.

    • setMinimumPercent

      public void setMinimumPercent(PercentType minimumPercent)
      Sets the minimum percentage for this instance. The minimum percentage is represented as a PercentType, which holds a value constrained between 0 and 1, inclusive. This percentage defines the threshold to be used in rollup rule evaluations.
      Parameters:
      minimumPercent - the PercentType object representing the minimum percentage value to set.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object