Package dev.jcputney.elearning.parser.input.lom.properties

Class ControlsSpec

java.lang.Object
dev.jcputney.elearning.parser.input.lom.properties.ControlsSpec
All Implemented Interfaces:
Serializable
public final class ControlsSpec extends Object implements Serializable

Represents the controlsSpec complex type.

The following schema snippet specifies its contents:


 <xs:complexType name="controlsSpec">
   <xs:all>
     <xs:element name="showFinishButton" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="showCloseItem" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="showHelp" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="showProgressBar" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="useMeasureProgressBar" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="showCourseStructure" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="courseStructureStartsOpen" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="showNavBar" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="showTitleBar" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="enableFlowNav" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="enableChoiceNav" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="statusDisplay" type="statusDisplayType" minOccurs="0" maxOccurs="1" />
     <xs:element name="forceDisableRootChoice" type="yesNoType" minOccurs="0" maxOccurs="1" />
   </xs:all>
 </xs:complexType>
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ControlsSpec()
    Default constructor for the ControlsSpec class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    YesNoType
    getCourseStructureStartsOpen()
    Retrieves the value of the courseStructureStartsOpen property, which determines whether the course structure starts in an open state or not.
    YesNoType
    getEnableChoiceNav()
    Retrieves the current state of the enableChoiceNav property.
    YesNoType
    getEnableFlowNav()
    Retrieves the value of the enableFlowNav property, which indicates whether the flow navigation functionality is enabled or disabled.
    YesNoType
    getForceDisableRootChoice()
    Retrieves the current value of the forceDisableRootChoice setting.
    YesNoType
    getShowCloseItem()
    Retrieves the value of the showCloseItem property, which indicates whether the "Close" item should be displayed or hidden.
    YesNoType
    getShowCourseStructure()
    Retrieves the value of the showCourseStructure property, which determines whether the course structure should be displayed or hidden.
    YesNoType
    getShowFinishButton()
    Retrieves the value of the showFinishButton property, which determines whether the "Finish" button should be displayed or not.
    YesNoType
    getShowHelp()
    Retrieves the value of the showHelp property, which defines whether the help section should be displayed or not.
    YesNoType
    getShowNavBar()
    Retrieves the value of the showNavBar property, which determines whether the navigation bar should be displayed or not.
    YesNoType
    getShowProgressBar()
    Retrieves the value of the showProgressBar property, which determines whether the progress bar should be displayed or not.
    YesNoType
    getShowTitleBar()
    Retrieves the value of the showTitleBar property, which determines whether the title bar should be displayed or not.
    StatusDisplayType
    getStatusDisplay()
    Retrieves the current status display type.
    YesNoType
    getUseMeasureProgressBar()
    Retrieves the value of the useMeasureProgressBar property, which determines whether the measure progress bar functionality is enabled or disabled.
    int
    hashCode()
     
    void
    setCourseStructureStartsOpen(YesNoType courseStructureStartsOpen)
    Sets the value of the courseStructureStartsOpen property, which determines whether the course structure should start in an open state or not.
    void
    setEnableChoiceNav(YesNoType enableChoiceNav)
    Sets the enableChoiceNav property to define whether choice navigation is enabled or not.
    void
    setEnableFlowNav(YesNoType enableFlowNav)
    Sets the flow navigation enablement status.
    void
    setForceDisableRootChoice(YesNoType forceDisableRootChoice)
    Sets the value indicating whether the root choice should be forcibly disabled.
    void
    setShowCloseItem(YesNoType showCloseItem)
    Sets the value of the showCloseItem property, which determines whether the "Close" item should be displayed or hidden.
    void
    setShowCourseStructure(YesNoType showCourseStructure)
    Sets the value of the showCourseStructure property, which determines whether the course structure should be displayed or hidden.
    void
    setShowFinishButton(YesNoType showFinishButton)
    Sets the value of the showFinishButton property, which determines whether the "Finish" button should be displayed or not.
    void
    setShowHelp(YesNoType showHelp)
    Sets the value of the showHelp property, determining whether the help section should be displayed or hidden.
    void
    setShowNavBar(YesNoType showNavBar)
    Sets the value of the showNavBar property, which determines whether the navigation bar should be displayed or hidden.
    void
    setShowProgressBar(YesNoType showProgressBar)
    Sets the value of the showProgressBar property, which determines whether the progress bar should be displayed or hidden.
    void
    setShowTitleBar(YesNoType showTitleBar)
    Sets whether the title bar should be displayed.
    void
    setStatusDisplay(StatusDisplayType statusDisplay)
    Updates the status display to the specified type.
    void
    setUseMeasureProgressBar(YesNoType useMeasureProgressBar)
    Sets the value of the useMeasureProgressBar property, which determines whether the measure progress bar functionality is enabled or disabled.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ControlsSpec

      public ControlsSpec()
      Default constructor for the ControlsSpec class. This constructor initializes a new instance of the ControlsSpec class. No specific initialization is performed in this constructor.

  • Method Details

    • getShowFinishButton

      public YesNoType getShowFinishButton()
      Retrieves the value of the showFinishButton property, which determines whether the "Finish" button should be displayed or not.
      Returns:
      the current value of the showFinishButton property, either as YES, NO, TRUE, or FALSE.

    • setShowFinishButton

      public void setShowFinishButton(YesNoType showFinishButton)
      Sets the value of the showFinishButton property, which determines whether the "Finish" button should be displayed or not.
      Parameters:
      showFinishButton - the value to set for the showFinishButton property. Accepts values of either YES, NO, TRUE, or FALSE, as defined by the YesNoType enum.

    • getShowCloseItem

      public YesNoType getShowCloseItem()
      Retrieves the value of the showCloseItem property, which indicates whether the "Close" item should be displayed or hidden.
      Returns:
      the current value of the showCloseItem property, represented as one of the values defined in the YesNoType enumeration (YES, NO, TRUE, or FALSE).

    • setShowCloseItem

      public void setShowCloseItem(YesNoType showCloseItem)
      Sets the value of the showCloseItem property, which determines whether the "Close" item should be displayed or hidden.
      Parameters:
      showCloseItem - the value to set for the showCloseItem property. Accepts values of either YES, NO, TRUE, or FALSE, as defined by the YesNoType enum.

    • getShowHelp

      public YesNoType getShowHelp()
      Retrieves the value of the showHelp property, which defines whether the help section should be displayed or not.
      Returns:
      the current value of the showHelp property, represented as one of the values in the YesNoType enumeration (YES, NO, TRUE, or FALSE).

    • setShowHelp

      public void setShowHelp(YesNoType showHelp)
      Sets the value of the showHelp property, determining whether the help section should be displayed or hidden.
      Parameters:
      showHelp - the value to set for the showHelp property. Accepts values of either YES, NO, TRUE, or FALSE, as defined by the YesNoType enum.

    • getShowProgressBar

      public YesNoType getShowProgressBar()
      Retrieves the value of the showProgressBar property, which determines whether the progress bar should be displayed or not.
      Returns:
      the current value of the showProgressBar property, represented as one of the values defined in the YesNoType enumeration (YES, NO, TRUE, or FALSE).

    • setShowProgressBar

      public void setShowProgressBar(YesNoType showProgressBar)
      Sets the value of the showProgressBar property, which determines whether the progress bar should be displayed or hidden.
      Parameters:
      showProgressBar - the value to set for the showProgressBar property. Accepts values of either YES, NO, TRUE, or FALSE, as defined by the YesNoType enum.

    • getUseMeasureProgressBar

      public YesNoType getUseMeasureProgressBar()
      Retrieves the value of the useMeasureProgressBar property, which determines whether the measure progress bar functionality is enabled or disabled.
      Returns:
      the current value of the useMeasureProgressBar property, represented as one of the values defined in the YesNoType enumeration (YES, NO, TRUE, or FALSE).

    • setUseMeasureProgressBar

      public void setUseMeasureProgressBar(YesNoType useMeasureProgressBar)
      Sets the value of the useMeasureProgressBar property, which determines whether the measure progress bar functionality is enabled or disabled.
      Parameters:
      useMeasureProgressBar - the value to set for the useMeasureProgressBar property. Accepts values of either YES, NO, TRUE, or FALSE, as defined by the YesNoType enum.

    • getShowCourseStructure

      public YesNoType getShowCourseStructure()
      Retrieves the value of the showCourseStructure property, which determines whether the course structure should be displayed or hidden.
      Returns:
      the current value of the showCourseStructure property, represented as one of the values defined in the YesNoType enumeration (YES, NO, TRUE, or FALSE).

    • setShowCourseStructure

      public void setShowCourseStructure(YesNoType showCourseStructure)
      Sets the value of the showCourseStructure property, which determines whether the course structure should be displayed or hidden.
      Parameters:
      showCourseStructure - the value to set for the showCourseStructure property. Accepts values of either YES, NO, TRUE, or FALSE, as defined by the YesNoType enum.

    • getCourseStructureStartsOpen

      public YesNoType getCourseStructureStartsOpen()
      Retrieves the value of the courseStructureStartsOpen property, which determines whether the course structure starts in an open state or not.
      Returns:
      the current value of the courseStructureStartsOpen property, represented as one of the values in the YesNoType enumeration (YES, NO, TRUE, or FALSE).

    • setCourseStructureStartsOpen

      public void setCourseStructureStartsOpen(YesNoType courseStructureStartsOpen)
      Sets the value of the courseStructureStartsOpen property, which determines whether the course structure should start in an open state or not.
      Parameters:
      courseStructureStartsOpen - the value to set for the courseStructureStartsOpen property. Accepts values of either YES, NO, TRUE, or FALSE, as defined by the YesNoType enum.

    • getShowNavBar

      public YesNoType getShowNavBar()
      Retrieves the value of the showNavBar property, which determines whether the navigation bar should be displayed or not.
      Returns:
      the current value of the showNavBar property, represented as one of the values in the YesNoType enumeration (YES, NO, TRUE, or FALSE).

    • setShowNavBar

      public void setShowNavBar(YesNoType showNavBar)
      Sets the value of the showNavBar property, which determines whether the navigation bar should be displayed or hidden.
      Parameters:
      showNavBar - the value to set for the showNavBar property. Accepts values of either YES, NO, TRUE, or FALSE, as defined by the YesNoType enum.

    • getShowTitleBar

      public YesNoType getShowTitleBar()
      Retrieves the value of the showTitleBar property, which determines whether the title bar should be displayed or not.
      Returns:
      the current value of the showTitleBar property, represented as one of the values in the YesNoType enumeration (YES, NO, TRUE, or FALSE).

    • setShowTitleBar

      public void setShowTitleBar(YesNoType showTitleBar)
      Sets whether the title bar should be displayed.
      Parameters:
      showTitleBar - a YesNoType value indicating if the title bar should be visible (Yes) or hidden (No)

    • getEnableFlowNav

      public YesNoType getEnableFlowNav()
      Retrieves the value of the enableFlowNav property, which indicates whether the flow navigation functionality is enabled or disabled.
      Returns:
      the current value of the enableFlowNav property, represented as one of the values in the YesNoType enumeration (YES, NO, TRUE, or FALSE).

    • setEnableFlowNav

      public void setEnableFlowNav(YesNoType enableFlowNav)
      Sets the flow navigation enablement status.
      Parameters:
      enableFlowNav - Determines whether flow navigation is enabled or disabled.

    • getEnableChoiceNav

      public YesNoType getEnableChoiceNav()
      Retrieves the current state of the enableChoiceNav property.
      Returns:
      a YesNoType value representing whether the choice navigation is enabled or not.

    • setEnableChoiceNav

      public void setEnableChoiceNav(YesNoType enableChoiceNav)
      Sets the enableChoiceNav property to define whether choice navigation is enabled or not.
      Parameters:
      enableChoiceNav - the YesNoType value indicating if choice navigation should be enabled

    • getStatusDisplay

      public StatusDisplayType getStatusDisplay()
      Retrieves the current status display type.
      Returns:
      the current status display of type StatusDisplayType

    • setStatusDisplay

      public void setStatusDisplay(StatusDisplayType statusDisplay)
      Updates the status display to the specified type.
      Parameters:
      statusDisplay - the new status display type to set

    • getForceDisableRootChoice

      public YesNoType getForceDisableRootChoice()
      Retrieves the current value of the forceDisableRootChoice setting.
      Returns:
      the value of forceDisableRootChoice of type YesNoType

    • setForceDisableRootChoice

      public void setForceDisableRootChoice(YesNoType forceDisableRootChoice)
      Sets the value indicating whether the root choice should be forcibly disabled.
      Parameters:
      forceDisableRootChoice - a value of type YesNoType that determines whether the root choice is forcibly disabled.

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object