Package dev.jcputney.elearning.parser.input.aicc

Class AiccCompletionCriteria

java.lang.Object
dev.jcputney.elearning.parser.input.aicc.AiccCompletionCriteria
All Implemented Interfaces:
Serializable
public final class AiccCompletionCriteria extends Object implements Serializable
Represents the completion criteria for AICC (Aviation Industry CBT Committee) standards. This class encapsulates various properties and rules used to determine the completion status of an AICC-based training module.

The class provides fields for standard completion attributes such as action, lesson status, and result status, as well as a collection for additional custom rules.

This is a serializable class and overrides the equals and hashCode methods to ensure proper equality checks and object usage in hash-based collections.

See Also:

  • Constructor Details

    • AiccCompletionCriteria

      public AiccCompletionCriteria()
      Constructs a new instance of the AiccCompletionCriteria class. This is a no-argument constructor that initializes an instance with default or unconfigured state. It does not perform any specific actions.

      The AiccCompletionCriteria class provides mechanisms for managing and defining the criteria used for determining the completion status in AICC-compliant learning environments. These criteria typically include actions, lesson statuses, result statuses, and additional rule definitions.

  • Method Details

    • getCompletionAction

      public String getCompletionAction()
      Retrieves the completion action associated with the AICC completion criteria.
      Returns:
      the completion action as a String

    • setCompletionAction

      public void setCompletionAction(String completionAction)
      Sets the completion action associated with the AICC completion criteria.
      Parameters:
      completionAction - the completion action as a String; defines the action that represents the completion criteria

    • getCompletionLessonStatus

      public String getCompletionLessonStatus()
      Retrieves the completion lesson status associated with the AICC completion criteria.
      Returns:
      the completion lesson status as a String

    • setCompletionLessonStatus

      public void setCompletionLessonStatus(String completionLessonStatus)
      Sets the completion lesson status associated with the AICC completion criteria.
      Parameters:
      completionLessonStatus - the completion lesson status as a String; defines the status that represents the completion criteria for a lesson

    • getCompletionResultStatus

      public String getCompletionResultStatus()
      Retrieves the completion result status associated with the AICC completion criteria.
      Returns:
      the completion result status as a String

    • setCompletionResultStatus

      public void setCompletionResultStatus(String completionResultStatus)
      Sets the completion result status associated with the AICC completion criteria.
      Parameters:
      completionResultStatus - the completion result status as a String; defines the result status that represents the completion criteria

    • getAdditionalRules

      public Map<String,String> getAdditionalRules()
      Retrieves the additional rules associated with the AICC completion criteria.
      Returns:
      a map containing the additional rules as key-value pairs, where the key and value represent the rule identifier and its corresponding value, respectively.

    • putAdditionalRule

      public void putAdditionalRule(String key, String value)
      Adds a new rule to the collection of additional rules. The rule is defined as a key-value pair. If the provided key is null or blank, the method does nothing.
      Parameters:
      key - the identifier for the rule to be added. Must not be null or blank.
      value - the corresponding value for the given key. Can be null.

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object