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

Class BehaviorSpec

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

Represents the behaviorSpec complex type.

The following schema snippet specifies its contents:


 <xs:complexType name="behaviorSpec">
   <xs:all>
     <xs:element name="launch" type="launchSpec" minOccurs="0" maxOccurs="1" />
     <xs:element name="exitActions" type="exitActionsSpec" minOccurs="0" maxOccurs="1" />
     <xs:element name="communications" type="communicationsSpec" minOccurs="0" maxOccurs="1" />
     <xs:element name="debug" type="debugSpec" minOccurs="0" maxOccurs="1" />
     <xs:element name="history" type="captureHistorySpec" minOccurs="0" maxOccurs="1" />
     <xs:element name="disableRightClick" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="preventWindowResize" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="scoreRollupMode" type="scoreRollupType" minOccurs="0" maxOccurs="1" />
     <xs:element name="numberOfScoringObjects" type="xs:int" minOccurs="0" maxOccurs="1" />
     <xs:element name="statusRollupMode" type="statusRollupType" minOccurs="0" maxOccurs="1" />
     <xs:element name="thresholdScoreForCompletion" type="xs:decimal" minOccurs="0" maxOccurs="1" />
     <xs:element name="applyRollupStatusToSuccess" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="firstScoIsPretest" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="finishCausesImmediateCommit" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="invalidMenuItemAction" type="invalidMenuItemActionType" minOccurs="0" maxOccurs="1" />
     <xs:element name="alwaysFlowToFirstSco" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="logoutCausesPlayerExit" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="resetRtTiming" type="resetRunTimeDataTimingType" minOccurs="0" maxOccurs="1" />
     <xs:element name="lookaheadSequencerMode" type="lookaheadSequencerModeType" minOccurs="0" maxOccurs="1" />
     <xs:element name="scoreOverridesStatus" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="allowCompleteStatusChange" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="scaleRawScore" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="useQuickLookaheadSequencer" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="rollupRuntimeAtScoUnload" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="forceObjectiveCompletionSetByContent" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="invokeRollupAtSuspendAll" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="completionStatOfFailedSuccessStat" type="completionStatusType" minOccurs="0" maxOccurs="1" />
     <xs:element name="satisfiedCausesCompletion" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="makeStudentPrefsGlobalToCourse" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="returnToLmsAction" type="returnToLmsActionType" minOccurs="0" maxOccurs="1" />
     <xs:element name="rollupEmptySetToUnknown" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="validateInteractionTypes" type="yesNoType" minOccurs="0" maxOccurs="1" />
     <xs:element name="suspendDataMaxLength" type="xs:int" minOccurs="0" maxOccurs="1" />
     <xs:element name="timeLimit" type="xs:int" minOccurs="0" maxOccurs="1" />
   </xs:all>
 </xs:complexType>
See Also:

  • Constructor Details

    • BehaviorSpec

      public BehaviorSpec()
      Constructs a new instance of BehaviorSpec.

      This constructor initializes the BehaviorSpec object with its default state. It does not perform any operations or take parameters.

  • Method Details

    • getLaunch

      public LaunchSpec getLaunch()
      Retrieves the launch specification.
      Returns:
      the LaunchSpec instance associated with this behavior.

    • setLaunch

      public void setLaunch(LaunchSpec launch)
      Sets the launch specification for the behavior.
      Parameters:
      launch - the LaunchSpec instance to associate with this behavior

    • getExitActions

      public ExitActionsSpec getExitActions()
      Retrieves the exit actions specification for the behavior.
      Returns:
      the ExitActionsSpec instance associated with this behavior.

    • setExitActions

      public void setExitActions(ExitActionsSpec exitActions)
      Sets the exit actions specification for the behavior.
      Parameters:
      exitActions - the ExitActionsSpec instance to associate with this behavior

    • getCommunications

      public CommunicationsSpec getCommunications()
      Retrieves the communications specification for the behavior.
      Returns:
      the CommunicationsSpec instance associated with this behavior.

    • setCommunications

      public void setCommunications(CommunicationsSpec communications)
      Sets the communications specification for the behavior.
      Parameters:
      communications - the CommunicationsSpec instance to associate with this behavior

    • getDebug

      public DebugSpec getDebug()
      Retrieves the debug specification for the behavior.
      Returns:
      the DebugSpec instance associated with this behavior.

    • setDebug

      public void setDebug(DebugSpec debug)
      Sets the debug specification for the behavior.
      Parameters:
      debug - the DebugSpec instance to associate with this behavior

    • getHistory

      public CaptureHistorySpec getHistory()
      Retrieves the capture history specification for the behavior.
      Returns:
      the CaptureHistorySpec instance associated with this behavior.

    • setHistory

      public void setHistory(CaptureHistorySpec history)
      Sets the capture history specification for the behavior.
      Parameters:
      history - the CaptureHistorySpec instance to associate with this behavior

    • getDisableRightClick

      public YesNoType getDisableRightClick()
      Retrieves the disable-right-click configuration for the behavior.
      Returns:
      the YesNoType value indicating whether right-click is disabled.

    • setDisableRightClick

      public void setDisableRightClick(YesNoType disableRightClick)
      Configures whether right-click functionality is disabled for this behavior.
      Parameters:
      disableRightClick - the YesNoType value indicating whether right-click functionality should be disabled.

    • getPreventWindowResize

      public YesNoType getPreventWindowResize()
      Retrieves the configuration indicating whether window resize prevention is enabled.
      Returns:
      the YesNoType value indicating whether window resizing is prevented.

    • setPreventWindowResize

      public void setPreventWindowResize(YesNoType preventWindowResize)
      Configures whether window resizing should be prevented for this behavior.
      Parameters:
      preventWindowResize - the YesNoType value indicating whether window resizing should be disabled (YES/NO/TRUE/FALSE).

    • getScoreRollupMode

      public ScoreRollupType getScoreRollupMode()
      Retrieves the score rollup mode setting for this behavior.
      Returns:
      the ScoreRollupType value indicating the current score rollup mode configuration.

    • setScoreRollupMode

      public void setScoreRollupMode(ScoreRollupType scoreRollupMode)
      Sets the score rollup mode for the behavior.
      Parameters:
      scoreRollupMode - the ScoreRollupType value to define how score rollup should be configured

    • getNumberOfScoringObjects

      public Integer getNumberOfScoringObjects()
      Retrieves the number of scoring objects associated with the behavior.
      Returns:
      the number of scoring objects as an Integer.

    • setNumberOfScoringObjects

      public void setNumberOfScoringObjects(Integer numberOfScoringObjects)
      Sets the number of scoring objects associated with the behavior.
      Parameters:
      numberOfScoringObjects - the Integer value representing the number of scoring objects to be set

    • getStatusRollupMode

      public StatusRollupType getStatusRollupMode()
      Retrieves the current status rollup mode.
      Returns:
      the status rollup mode of type StatusRollupType

    • setStatusRollupMode

      public void setStatusRollupMode(StatusRollupType statusRollupMode)
      Sets the status rollup mode for the current instance.
      Parameters:
      statusRollupMode - the status rollup mode to be applied. This determines how statuses are aggregated or rolled up.

    • getThresholdScoreForCompletion

      public BigDecimal getThresholdScoreForCompletion()
      Retrieves the threshold score required for completion.
      Returns:
      the threshold score as a BigDecimal value.

    • setThresholdScoreForCompletion

      public void setThresholdScoreForCompletion(BigDecimal thresholdScoreForCompletion)
      Sets the threshold score required for completion.
      Parameters:
      thresholdScoreForCompletion - the score that represents the completion threshold

    • getApplyRollupStatusToSuccess

      public YesNoType getApplyRollupStatusToSuccess()
      Retrieves the current rollup status indicating whether it should be applied to success.
      Returns:
      a YesNoType value representing whether rollup status is applied to success

    • setApplyRollupStatusToSuccess

      public void setApplyRollupStatusToSuccess(YesNoType applyRollupStatusToSuccess)
      Sets the apply rollup status to success.
      Parameters:
      applyRollupStatusToSuccess - The value indicating whether the rollup status should be applied as a success.

    • getFirstScoIsPretest

      public YesNoType getFirstScoIsPretest()
      Retrieves the value indicating whether the first SCO (Shareable Content Object) is a pretest.
      Returns:
      a YesNoType value representing whether the first SCO is a pretest.

    • setFirstScoIsPretest

      public void setFirstScoIsPretest(YesNoType firstScoIsPretest)
      Sets the value indicating whether the first SCO (Shareable Content Object) is a pretest.
      Parameters:
      firstScoIsPretest - an instance of YesNoType that specifies if the first SCO is a pretest

    • getFinishCausesImmediateCommit

      public YesNoType getFinishCausesImmediateCommit()
      Retrieves the value indicating whether finishing causes an immediate commit.
      Returns:
      the value of finishCausesImmediateCommit, represented as YesNoType.

    • setFinishCausesImmediateCommit

      public void setFinishCausesImmediateCommit(YesNoType finishCausesImmediateCommit)
      Sets whether finishing causes an immediate commit.
      Parameters:
      finishCausesImmediateCommit - A YesNoType value indicating whether the finish action should cause an immediate commit.

    • getInvalidMenuItemAction

      public InvalidMenuItemActionType getInvalidMenuItemAction()
      Retrieves the action type associated with invalid menu items.
      Returns:
      the InvalidMenuItemActionType representing the action to be taken for invalid menu items.

    • setInvalidMenuItemAction

      public void setInvalidMenuItemAction(InvalidMenuItemActionType invalidMenuItemAction)
      Sets the action to be taken when an invalid menu item is encountered.
      Parameters:
      invalidMenuItemAction - the action to set, represented by an InvalidMenuItemActionType enumeration

    • getAlwaysFlowToFirstSco

      public YesNoType getAlwaysFlowToFirstSco()
      Retrieves the value indicating whether the flow should always go to the first SCO (Sharable Content Object).
      Returns:
      a YesNoType value that specifies whether the flow always goes to the first SCO.

    • setAlwaysFlowToFirstSco

      public void setAlwaysFlowToFirstSco(YesNoType alwaysFlowToFirstSco)
      Sets whether the flow should always proceed to the first SCO (Sharable Content Object).
      Parameters:
      alwaysFlowToFirstSco - an instance of YesNoType indicating whether the flow should always start at the first SCO.

    • getLogoutCausesPlayerExit

      public YesNoType getLogoutCausesPlayerExit()
      Retrieves whether the player's logout causes their exit.
      Returns:
      A YesNoType value indicating if logout causes the player to exit.

    • setLogoutCausesPlayerExit

      public void setLogoutCausesPlayerExit(YesNoType logoutCausesPlayerExit)
      Sets whether logging out causes the player to exit.
      Parameters:
      logoutCausesPlayerExit - specifies if the player exit should occur on logout.

    • getResetRtTiming

      public ResetRunTimeDataTimingType getResetRtTiming()
      Retrieves the timing configuration for resetting runtime data.
      Returns:
      the reset runtime data timing configuration as a ResetRunTimeDataTimingType object.

    • setResetRtTiming

      public void setResetRtTiming(ResetRunTimeDataTimingType resetRtTiming)
      Sets the reset runtime data timing.
      Parameters:
      resetRtTiming - the ResetRunTimeDataTimingType object representing the reset runtime data timing to be set

    • getLookaheadSequencerMode

      public LookaheadSequencerModeType getLookaheadSequencerMode()
      Retrieves the current mode of the lookahead sequencer.
      Returns:
      the LookaheadSequencerModeType representing the current mode of the lookahead sequencer.

    • setLookaheadSequencerMode

      public void setLookaheadSequencerMode(LookaheadSequencerModeType lookaheadSequencerMode)
      Sets the lookahead sequencer mode for the current instance.
      Parameters:
      lookaheadSequencerMode - the lookahead sequencer mode to be set, represented as a LookaheadSequencerModeType.

    • getScoreOverridesStatus

      public YesNoType getScoreOverridesStatus()
      Retrieves the status of score overrides.
      Returns:
      an instance of YesNoType representing the score overrides status

    • setScoreOverridesStatus

      public void setScoreOverridesStatus(YesNoType scoreOverridesStatus)
      Sets the status for score overrides.
      Parameters:
      scoreOverridesStatus - the status indicating whether score overrides are enabled or not, represented as a YesNoType value

    • getAllowCompleteStatusChange

      public YesNoType getAllowCompleteStatusChange()
      Retrieves the current status indicating whether a complete status change is allowed.
      Returns:
      the allowCompleteStatusChange value as a YesNoType.

    • setAllowCompleteStatusChange

      public void setAllowCompleteStatusChange(YesNoType allowCompleteStatusChange)
      Sets whether the status change to 'complete' is allowed or not.
      Parameters:
      allowCompleteStatusChange - a YesNoType value indicating if the status change to 'complete' is permitted

    • getScaleRawScore

      public YesNoType getScaleRawScore()
      Retrieves the raw score associated with the scale.
      Returns:
      the scale raw score of type YesNoType

    • setScaleRawScore

      public void setScaleRawScore(YesNoType scaleRawScore)
      Sets the value of the scaleRawScore field.
      Parameters:
      scaleRawScore - the YesNoType value to set for scaleRawScore

    • getUseQuickLookaheadSequencer

      public YesNoType getUseQuickLookaheadSequencer()
      Retrieves the current setting for the quick lookahead sequencer usage.
      Returns:
      a YesNoType value indicating whether the quick lookahead sequencer is enabled or disabled.

    • setUseQuickLookaheadSequencer

      public void setUseQuickLookaheadSequencer(YesNoType useQuickLookaheadSequencer)
      Sets the flag to determine whether to use the quick lookahead sequencer.
      Parameters:
      useQuickLookaheadSequencer - the value indicating whether to enable or disable the quick lookahead sequencer

    • getRollupRuntimeAtScoUnload

      public YesNoType getRollupRuntimeAtScoUnload()
      Retrieves the rollup runtime state at the time of SCO (Shareable Content Object) unload.
      Returns:
      a YesNoType value representing whether rollup runtime calculations occur at SCO unload.

    • setRollupRuntimeAtScoUnload

      public void setRollupRuntimeAtScoUnload(YesNoType rollupRuntimeAtScoUnload)
      Sets whether the rollup runtime should be triggered during SCO unload.
      Parameters:
      rollupRuntimeAtScoUnload - a YesNoType value indicating whether to enable or disable the rollup runtime at SCO unload

    • getForceObjectiveCompletionSetByContent

      public YesNoType getForceObjectiveCompletionSetByContent()
      Retrieves the value indicating whether the objective completion is forcibly set by content.
      Returns:
      YesNoType value representing whether the objective completion is forcibly set by content.

    • setForceObjectiveCompletionSetByContent

      public void setForceObjectiveCompletionSetByContent(YesNoType forceObjectiveCompletionSetByContent)
      Sets the force objective completion state based on the provided content.
      Parameters:
      forceObjectiveCompletionSetByContent - the value indicating whether the objective completion should be forced by the content

    • getInvokeRollupAtSuspendAll

      public YesNoType getInvokeRollupAtSuspendAll()
      Retrieves the current value of the invokeRollupAtSuspendAll property.
      Returns:
      the value of invokeRollupAtSuspendAll of type YesNoType

    • setInvokeRollupAtSuspendAll

      public void setInvokeRollupAtSuspendAll(YesNoType invokeRollupAtSuspendAll)
      Sets the invokeRollupAtSuspendAll flag to the specified value.
      Parameters:
      invokeRollupAtSuspendAll - the value indicating whether to invoke rollup logic at suspend-all operation

    • getCompletionStatOfFailedSuccessStat

      public CompletionStatusType getCompletionStatOfFailedSuccessStat()
      Retrieves the completion status corresponding to the failed success status.
      Returns:
      the completion status type associated with the failed success status

    • setCompletionStatOfFailedSuccessStat

      public void setCompletionStatOfFailedSuccessStat(CompletionStatusType completionStatOfFailedSuccessStat)
      Sets the completion status for a failed success status.
      Parameters:
      completionStatOfFailedSuccessStat - the completion status to be set for the failed success status

    • getSatisfiedCausesCompletion

      public YesNoType getSatisfiedCausesCompletion()
      Retrieves the value of the satisfiedCausesCompletion property.
      Returns:
      the YesNoType value indicating whether the satisfaction causes completion.

    • setSatisfiedCausesCompletion

      public void setSatisfiedCausesCompletion(YesNoType satisfiedCausesCompletion)
      Sets the value indicating whether the satisfaction causes completion.
      Parameters:
      satisfiedCausesCompletion - a YesNoType value representing whether the satisfaction of a condition causes completion

    • getMakeStudentPrefsGlobalToCourse

      public YesNoType getMakeStudentPrefsGlobalToCourse()
      Retrieves the setting that determines if student preferences are made global to the course.
      Returns:
      the YesNoType value indicating whether the student preferences are global to the course

    • setMakeStudentPrefsGlobalToCourse

      public void setMakeStudentPrefsGlobalToCourse(YesNoType makeStudentPrefsGlobalToCourse)
      Sets whether the student preferences should be made global to the course.
      Parameters:
      makeStudentPrefsGlobalToCourse - a YesNoType value indicating whether student preferences are global to the course

    • getReturnToLmsAction

      public ReturnToLmsActionType getReturnToLmsAction()
      Retrieves the action type associated with returning to the Learning Management System (LMS).
      Returns:
      the type of action that defines how to return to the LMS, represented as a ReturnToLmsActionType object.

    • setReturnToLmsAction

      public void setReturnToLmsAction(ReturnToLmsActionType returnToLmsAction)
      Sets the action to be taken when returning to the Learning Management System (LMS).
      Parameters:
      returnToLmsAction - the action type to be set for returning to the LMS

    • getRollupEmptySetToUnknown

      public YesNoType getRollupEmptySetToUnknown()
      Retrieves the rollup behavior for handling an empty set, which determines whether the system should interpret it as an unknown state.
      Returns:
      The current configuration setting for rollupEmptySetToUnknown, represented as a YesNoType value.

    • setRollupEmptySetToUnknown

      public void setRollupEmptySetToUnknown(YesNoType rollupEmptySetToUnknown)
      Sets the behavior for handling roll-ups when the input set is empty. Determines whether an empty set should be treated as unknown in roll-up calculations.
      Parameters:
      rollupEmptySetToUnknown - the value that specifies how empty sets are processed in roll-ups. A value of Yes indicates treating the empty set as unknown, while No indicates not treating it as unknown.

    • getValidateInteractionTypes

      public YesNoType getValidateInteractionTypes()
      Retrieves the validate interaction types configured for this instance.
      Returns:
      the validate interaction types as a YesNoType value

    • setValidateInteractionTypes

      public void setValidateInteractionTypes(YesNoType validateInteractionTypes)
      Sets the option to validate interaction types.
      Parameters:
      validateInteractionTypes - a YesNoType indicating whether to enable or disable interaction type validation

    • getSuspendDataMaxLength

      public Integer getSuspendDataMaxLength()
      Retrieves the maximum length allowed for suspension data.
      Returns:
      the maximum length of the suspension data as an Integer

    • setSuspendDataMaxLength

      public void setSuspendDataMaxLength(Integer suspendDataMaxLength)
      Sets the maximum length for suspend data.
      Parameters:
      suspendDataMaxLength - the maximum length of suspend data to be set

    • getTimeLimit

      public Integer getTimeLimit()
      Retrieves the time limit value.
      Returns:
      the time limit as an Integer

    • setTimeLimit

      public void setTimeLimit(Integer timeLimit)
      Sets the time limit for the operation.
      Parameters:
      timeLimit - the time limit to set, in milliseconds. Should be a non-negative integer.

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object