Package dev.jcputney.elearning.parser.input.cmi5

Class AU

java.lang.Object
dev.jcputney.elearning.parser.input.cmi5.AU
All Implemented Interfaces:
Serializable
public final class AU extends Object implements Serializable
Represents an Assignable Unit (AU) in a CMI5 course structure. An AU is a distinct learning activity or resource that can be assigned to learners.

Defined in the schema as:


 <xs:complexType name="auType">
   <xs:sequence>
     <xs:element name="title" type="textType"/>
     <xs:element name="description" type="textType"/>
     <xs:element name="objectives" type="referencesObjectivesType" minOccurs="0"/>
     <xs:element name="url">
       <xs:simpleType>
         <xs:restriction base="xs:anyURI">
           <xs:minLength value="1"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:element>
     <xs:element name="launchParameters" minOccurs="0"/>
     <xs:element name="entitlementKey" minOccurs="0"/>
     <xs:group ref="anyElement"/>
   </xs:sequence>
   <xs:attributeGroup ref="anyAttribute"/>
   <xs:attribute name="id" type="xs:anyURI" use="required"/>
   <xs:attribute name="moveOn" default="NotApplicable">
     <xs:simpleType>
       <xs:restriction base="xs:string">
         <xs:enumeration value="NotApplicable"/>
         <xs:enumeration value="Passed"/>
         <xs:enumeration value="Completed"/>
         <xs:enumeration value="CompletedAndPassed"/>
         <xs:enumeration value="CompletedOrPassed"/>
       </xs:restriction>
     </xs:simpleType>
   </xs:attribute>
   <xs:attribute name="masteryScore" use="optional">
     <xs:simpleType>
       <xs:restriction base="xs:decimal">
         <xs:minInclusive value="0"/>
         <xs:maxInclusive value="1"/>
       </xs:restriction>
     </xs:simpleType>
   </xs:attribute>
   <xs:attribute name="launchMethod" default="AnyWindow">
     <xs:simpleType>
       <xs:restriction base="xs:string">
         <xs:enumeration value="AnyWindow"/>
         <xs:enumeration value="OwnWindow"/>
       </xs:restriction>
     </xs:simpleType>
   </xs:attribute>
   <xs:attribute name="activityType" use="optional" type="xs:string"/>
 </xs:complexType>
See Also:

  • Constructor Details

    • AU

      public AU(TextType title, TextType description, ReferencesObjectives objectives, String url, String launchParameters, String entitlementKey, String id, MoveOn moveOn, PercentType masteryScore, LaunchMethod launchMethod, String activityType)
      Constructs a new instance of AU with the specified parameters.
      Parameters:
      title - the title of the AU, represented as a TextType, which supports multi-language localized text
      description - the description of the AU, represented as a TextType, which supports multi-language localized text
      objectives - the objectives associated with the AU, represented as a ReferencesObjectives object
      url - the URL associated with the AU, represented as a String
      launchParameters - the launch parameters for the AU, represented as a String
      entitlementKey - the entitlement key for the AU, represented as a String
      id - the unique identifier for the AU, represented as a String
      moveOn - the MoveOn enum value representing the conditions that must be met to move on to the next activity
      masteryScore - the mastery score for the AU, represented as a PercentType, which is a percentage value constrained between 0 and 1, inclusive
      launchMethod - the LaunchMethod enum value specifying the method used to launch the activity
      activityType - the activity type associated with the AU, represented as a String

    • AU

      public AU()
      Default constructor for the AU class. Initializes a new instance of the AU class without setting any field values. This constructor performs no operations and is intended for scenarios where an instance of AU is required but specific initialization is not necessary.

  • Method Details

    • getTitle

      public TextType getTitle()
      Retrieves the title of the current instance.
      Returns:
      the title as a TextType representing localized text.

    • setTitle

      public void setTitle(TextType title)
      Updates the title for the current instance.
      Parameters:
      title - the new title, represented as a TextType, which supports multi-language localized text

    • getDescription

      public TextType getDescription()
      Retrieves the description of the current instance.
      Returns:
      the description as a TextType, which represents localized text.

    • setDescription

      public void setDescription(TextType description)
      Updates the description for the current instance.
      Parameters:
      description - the new description, represented as a TextType, which supports multi-language localized text

    • getObjectives

      public ReferencesObjectives getObjectives()
      Retrieves the objectives of the current instance.
      Returns:
      a ReferencesObjectives object representing the objectives associated with the current instance.

    • setObjectives

      public void setObjectives(ReferencesObjectives objectives)
      Updates the objectives for the current instance.
      Parameters:
      objectives - the new ReferencesObjectives object representing the objectives associated with the current instance.

    • getUrl

      public String getUrl()
      Retrieves the URL associated with the current instance.
      Returns:
      the URL as a String.

    • setUrl

      public void setUrl(String url)
      Updates the URL for the current instance.
      Parameters:
      url - the new URL, represented as a String.

    • getLaunchParameters

      public String getLaunchParameters()
      Retrieves the launch parameters associated with the current instance.
      Returns:
      a String representing the launch parameters.

    • setLaunchParameters

      public void setLaunchParameters(String launchParameters)
      Updates the launch parameters for the current instance.
      Parameters:
      launchParameters - the new launch parameters, represented as a String.

    • getEntitlementKey

      public String getEntitlementKey()
      Retrieves the entitlement key associated with the current instance.
      Returns:
      a String representing the entitlement key.

    • setEntitlementKey

      public void setEntitlementKey(String entitlementKey)
      Sets the entitlement key for the current instance.
      Parameters:
      entitlementKey - the new entitlement key, represented as a String.

    • getId

      public String getId()
      Retrieves the unique identifier associated with the current instance.
      Returns:
      a String representing the unique identifier.

    • setId

      public void setId(String id)
      Updates the unique identifier for the current instance.
      Parameters:
      id - the new unique identifier, represented as a String.

    • getMoveOn

      public MoveOn getMoveOn()
      Retrieves the MoveOn value associated with the current instance.
      Returns:
      the MoveOn enum value representing the conditions for moving on to the next activity.

    • setMoveOn

      public void setMoveOn(MoveOn moveOn)
      Updates the MoveOn value for the current instance.
      Parameters:
      moveOn - the new MoveOn enum value representing the conditions that must be met to move on to the next activity.

    • getMasteryScore

      public PercentType getMasteryScore()
      Retrieves the mastery score associated with the current instance.
      Returns:
      a PercentType representing the mastery score, which is defined as a percentage value constrained between 0 and 1, inclusive.

    • setMasteryScore

      public void setMasteryScore(PercentType masteryScore)
      Updates the mastery score for the current instance.
      Parameters:
      masteryScore - the new mastery score, represented as a PercentType, which is a percentage value constrained between 0 and 1, inclusive.

    • getLaunchMethod

      public LaunchMethod getLaunchMethod()
      Retrieves the launch method associated with the current instance.
      Returns:
      the LaunchMethod, an enum representing the method used to launch the activity.

    • setLaunchMethod

      public void setLaunchMethod(LaunchMethod launchMethod)
      Sets the LaunchMethod for the current instance.
      Parameters:
      launchMethod - the LaunchMethod enum value specifying the method used to launch the activity. It determines whether the activity can launch in any window or must be launched in its own window.

    • getActivityType

      public String getActivityType()
      Retrieves the activity type associated with the current instance.
      Returns:
      a String representing the activity type.

    • setActivityType

      public void setActivityType(String activityType)
      Updates the activity type for the current instance.
      Parameters:
      activityType - the new activity type, represented as a String.

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object