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

Class ControlMode

java.lang.Object
dev.jcputney.elearning.parser.input.scorm2004.ims.ss.sequencing.ControlMode
All Implemented Interfaces:
Serializable
public final class ControlMode extends Object implements Serializable
Represents the control mode settings for a learning activity within the SCORM IMS Simple Sequencing (IMSSS) schema. The control mode determines the navigation options available to the learner, such as whether they are allowed to navigate freely, use flow-based navigation, and revisit previously accessed activities.

Each control mode attribute specifies a particular navigation control option, allowing authors to restrict or enable navigation behaviors according to the instructional design of the SCORM package.

The available control modes include:

  • Choice: Allows the learner to freely navigate between available activities.
  • Choice Exit: Allows the learner to exit from an activity and return to a previously accessed one.
  • Flow: Enables linear or sequential navigation through activities.
  • Forward Only: Restricts the learner to moving forward through the activities without going back.
  • Use Current Attempt Objective Info: Indicates whether the current attempt's objective information is used in sequencing.
  • Use Current Attempt Progress Info: Indicates whether the current attempt's progress information is used in sequencing.

These attributes control navigation at the activity level, allowing for flexibility in sequencing logic based on the learner's progress and interactions with the SCORM content.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ControlMode()
    Default constructor for the ControlMode class.
    ControlMode(boolean choice, boolean choiceExit, boolean flow, boolean forwardOnly, boolean useCurrentAttemptObjectiveInfo, boolean useCurrentAttemptProgressInfo)
    Constructor for the ControlMode class, which allows customization of various navigation and information usage settings.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    int
    hashCode()
     
    boolean
    isChoice()
    Indicates whether the "choice" option is enabled for the current instance of the control mode.
    boolean
    isChoiceExit()
    Determines whether the "choiceExit" option is enabled for the current instance of the control mode.
    boolean
    isFlow()
    Determines whether the "flow" option is enabled for the current instance of the control mode.
    boolean
    isForwardOnly()
    Determines whether the "forwardOnly" option is enabled for the current instance of the control mode.
    boolean
    isUseCurrentAttemptObjectiveInfo()
    Determines whether the "useCurrentAttemptObjectiveInfo" option is enabled for the current instance of the control mode.
    boolean
    isUseCurrentAttemptProgressInfo()
    Determines whether the "useCurrentAttemptProgressInfo" option is enabled for the current instance of the control mode.
    void
    setChoice(boolean choice)
    Sets the "choice" option for the current instance of the control mode.
    void
    setChoiceExit(boolean choiceExit)
    Sets the "choiceExit" option for the current instance of the control mode.
    void
    setFlow(boolean flow)
    Sets the "flow" option for the current instance of the control mode.
    void
    setForwardOnly(boolean forwardOnly)
    Sets the "forwardOnly" option for the current instance, specifying whether navigation through content is restricted to a forward direction only.
    void
    setUseCurrentAttemptObjectiveInfo(boolean useCurrentAttemptObjectiveInfo)
    Sets the "useCurrentAttemptObjectiveInfo" option for the current instance of the control mode.
    void
    setUseCurrentAttemptProgressInfo(boolean useCurrentAttemptProgressInfo)
    Sets the "useCurrentAttemptProgressInfo" option for the current instance of the control mode.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ControlMode

      public ControlMode(boolean choice, boolean choiceExit, boolean flow, boolean forwardOnly, boolean useCurrentAttemptObjectiveInfo, boolean useCurrentAttemptProgressInfo)
      Constructor for the ControlMode class, which allows customization of various navigation and information usage settings.
      Parameters:
      choice - a boolean value indicating whether the "choice" option is enabled (true) or disabled (false)
      choiceExit - a boolean value indicating whether the "choiceExit" option is enabled (true) or disabled (false)
      flow - a boolean value indicating whether the "flow" navigation option is enabled (true) or disabled (false)
      forwardOnly - a boolean value indicating whether navigation is restricted to a forward-only direction (true) or not (false)
      useCurrentAttemptObjectiveInfo - a boolean value indicating whether to use objective information for the current attempt (true) or not (false)
      useCurrentAttemptProgressInfo - a boolean value indicating whether to use progress information for the current attempt (true) or not (false)

    • ControlMode

      public ControlMode()
      Default constructor for the ControlMode class. This constructor initializes the ControlMode instance with default settings. The fields will be initialized to their default values, such as false for boolean fields.

  • Method Details

    • isChoice

      public boolean isChoice()
      Indicates whether the "choice" option is enabled for the current instance of the control mode.
      Returns:
      true if the "choice" option is enabled, false otherwise.

    • setChoice

      public void setChoice(boolean choice)
      Sets the "choice" option for the current instance of the control mode.
      Parameters:
      choice - a boolean value indicating whether the "choice" option is enabled (true) or disabled (false)

    • isChoiceExit

      public boolean isChoiceExit()
      Determines whether the "choiceExit" option is enabled for the current instance of the control mode.
      Returns:
      true if the "choiceExit" option is enabled, false otherwise.

    • setChoiceExit

      public void setChoiceExit(boolean choiceExit)
      Sets the "choiceExit" option for the current instance of the control mode.
      Parameters:
      choiceExit - a boolean value indicating whether the "choiceExit" option is enabled (true) or disabled (false)

    • isFlow

      public boolean isFlow()
      Determines whether the "flow" option is enabled for the current instance of the control mode.
      Returns:
      true if the "flow" option is enabled, false otherwise.

    • setFlow

      public void setFlow(boolean flow)
      Sets the "flow" option for the current instance of the control mode.
      Parameters:
      flow - a boolean value indicating whether the "flow" option is enabled (true) or disabled (false)

    • isForwardOnly

      public boolean isForwardOnly()
      Determines whether the "forwardOnly" option is enabled for the current instance of the control mode.
      Returns:
      true if the "forwardOnly" option is enabled, false otherwise.

    • setForwardOnly

      public void setForwardOnly(boolean forwardOnly)
      Sets the "forwardOnly" option for the current instance, specifying whether navigation through content is restricted to a forward direction only.
      Parameters:
      forwardOnly - a boolean value indicating whether the "forwardOnly" option is enabled (true) or disabled (false)

    • isUseCurrentAttemptObjectiveInfo

      public boolean isUseCurrentAttemptObjectiveInfo()
      Determines whether the "useCurrentAttemptObjectiveInfo" option is enabled for the current instance of the control mode. This option specifies if the objective information for the current attempt should be considered.
      Returns:
      true if the "useCurrentAttemptObjectiveInfo" option is enabled, false otherwise.

    • setUseCurrentAttemptObjectiveInfo

      public void setUseCurrentAttemptObjectiveInfo(boolean useCurrentAttemptObjectiveInfo)
      Sets the "useCurrentAttemptObjectiveInfo" option for the current instance of the control mode. This option determines whether the objective information for the current attempt should be used.
      Parameters:
      useCurrentAttemptObjectiveInfo - a boolean value indicating whether the "useCurrentAttemptObjectiveInfo" option should be enabled (true) or disabled (false)

    • isUseCurrentAttemptProgressInfo

      public boolean isUseCurrentAttemptProgressInfo()
      Determines whether the "useCurrentAttemptProgressInfo" option is enabled for the current instance of the control mode. This option specifies if the progress information for the current attempt should be considered.
      Returns:
      true if the "useCurrentAttemptProgressInfo" option is enabled, false otherwise.

    • setUseCurrentAttemptProgressInfo

      public void setUseCurrentAttemptProgressInfo(boolean useCurrentAttemptProgressInfo)
      Sets the "useCurrentAttemptProgressInfo" option for the current instance of the control mode. This option determines whether the progress information for the current attempt should be used.
      Parameters:
      useCurrentAttemptProgressInfo - a boolean value indicating whether the "useCurrentAttemptProgressInfo" option should be enabled (true) or disabled (false)

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object