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

Class RollupRules

java.lang.Object
dev.jcputney.elearning.parser.input.scorm2004.ims.ss.rollup.RollupRules
All Implemented Interfaces:
Serializable
public final class RollupRules extends Object implements Serializable
Represents a set of rollup rules within the SCORM IMS Simple Sequencing (IMSSS) schema. Rollup rules define how the completion status, progress, and satisfaction of learning objectives are aggregated or "rolled up" from child activities to their parent activities in the content hierarchy.

Rollup rules are used to determine whether a parent activity (such as a module or course) is considered complete or satisfied based on the statuses of its child activities. By configuring these rules, instructional designers can define custom logic for calculating the overall completion and success of a sequence based on individual activities within that sequence.

Common configurations include:

  • Requiring all child activities to be completed before the parent activity is considered complete.
  • Setting a minimum number of child activities to be completed or a minimum percentage of completion.
  • Specifying objective weights to control the impact of each activity on the overall progress.

The IMSSS namespace is specified by IMSSS.NAMESPACE_URI, following the SCORM 2004 standards for sequencing and navigation.

See Also:

  • Constructor Details

    • RollupRules

      public RollupRules(List<RollupRule> rollupRuleList, boolean rollupObjectiveSatisfied, boolean rollupProgressCompletion, double objectiveMeasureWeight)
      Constructs a RollupRules object with the specified parameters.
      Parameters:
      rollupRuleList - a list of RollupRule objects representing the rollup rules to be associated with this instance
      rollupObjectiveSatisfied - a boolean value indicating whether the rollup objective is satisfied
      rollupProgressCompletion - a boolean value indicating whether the rollup progress completion condition is met
      objectiveMeasureWeight - a double value representing the weight of the objective measure

    • RollupRules

      public RollupRules()
      Default constructor for the RollupRules class. Creates an instance of RollupRules with no initial configuration.

  • Method Details

    • getRollupRuleList

      public List<RollupRule> getRollupRuleList()
      Retrieves the list of rollup rules associated with this instance.
      Returns:
      a list of RollupRule objects representing the rollup rules.

    • setRollupRuleList

      public void setRollupRuleList(List<RollupRule> rollupRuleList)
      Sets the list of rollup rules for this instance.
      Parameters:
      rollupRuleList - a list of RollupRule objects to be associated with this instance

    • isRollupObjectiveSatisfied

      public boolean isRollupObjectiveSatisfied()
      Determines whether the rollup objective is satisfied for this instance.
      Returns:
      true if the rollup objective is satisfied, false otherwise.

    • setRollupObjectiveSatisfied

      public void setRollupObjectiveSatisfied(boolean rollupObjectiveSatisfied)
      Sets the status of whether the rollup objective is satisfied for this instance.
      Parameters:
      rollupObjectiveSatisfied - a boolean value indicating whether the rollup objective is satisfied

    • isRollupProgressCompletion

      public boolean isRollupProgressCompletion()
      Determines whether the rollup progress completion condition is met for this instance.
      Returns:
      true if the rollup progress completion is satisfied, false otherwise.

    • setRollupProgressCompletion

      public void setRollupProgressCompletion(boolean rollupProgressCompletion)
      Sets the status of whether the rollup progress completion condition is met for this instance.
      Parameters:
      rollupProgressCompletion - a boolean value indicating whether the rollup progress completion condition is satisfied

    • getObjectiveMeasureWeight

      public double getObjectiveMeasureWeight()
      Retrieves the weight of the objective measure associated with this instance.
      Returns:
      a double value representing the weight of the objective measure.

    • setObjectiveMeasureWeight

      public void setObjectiveMeasureWeight(double objectiveMeasureWeight)
      Sets the weight of the objective measure for this instance.
      Parameters:
      objectiveMeasureWeight - a double value representing the weight of the objective measure

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object