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

Class General

java.lang.Object
dev.jcputney.elearning.parser.input.lom.General
All Implemented Interfaces:
Serializable
public final class General extends Object implements Serializable
Represents the general element in the LOM schema, which provides general information about a learning object. This includes its identifiers, titles, language, descriptions, keywords, and other general metadata.

The following schema snippet defines the general element:


 <xs:complexType name="general">
   <xs:choice minOccurs="0" maxOccurs="unbounded">
     <xs:group ref="identifier"/>
     <xs:group ref="title"/>
     <xs:group ref="languageIdOrNone"/>
     <xs:group ref="descriptionUnbounded"/>
     <xs:group ref="keyword"/>
     <xs:group ref="coverage"/>
     <xs:group ref="structure"/>
     <xs:group ref="aggregationLevel"/>
     <xs:group ref="ex:customElements"/>
   </xs:choice>
   <xs:attributeGroup ref="ag:general"/>
 </xs:complexType>
See Also:

  • Constructor Details

    • General

      public General(List<Identifier> identifiers, UnboundLangString title, List<CatalogEntry> catalogEntries, String language, UnboundLangString description, List<UnboundLangString> keywords, UnboundLangString coverage, SourceValuePair<Structure> structure, SourceValuePair<AggregationLevel> aggregationLevel)
      Constructs a new General object with the specified parameters.
      Parameters:
      identifiers - a list of Identifier objects representing the identifiers associated with this object
      title - an UnboundLangString representing the title of this object, which may include multiple string values with language attributes
      catalogEntries - a list of CatalogEntry objects representing catalog entries associated with this object
      language - a String representing the language associated with this object
      description - an UnboundLangString representing the description of this object, which may include multiple string values with language attributes
      keywords - a list of UnboundLangString objects representing the keywords, which may include multiple string values with language attributes
      coverage - an UnboundLangString representing the coverage information, which may include multiple string values with language attributes
      structure - a SourceValuePair<Structure> representing the structure of the learning object associated with this instance
      aggregationLevel - a SourceValuePair<AggregationLevel> representing the aggregation level, which specifies the level of granularity or complexity of the learning object

    • General

      public General()
      Default constructor for the General class.

      This constructor initializes an empty instance of General without setting any fields.

  • Method Details

    • getIdentifiers

      public List<Identifier> getIdentifiers()
      Retrieves the list of identifiers associated with the instance.
      Returns:
      a list of Identifier objects representing the identifiers

    • setIdentifiers

      public void setIdentifiers(List<Identifier> identifiers)
      Sets the list of identifiers associated with the instance.
      Parameters:
      identifiers - a list of Identifier objects representing the identifiers to be set

    • getTitle

      public UnboundLangString getTitle()
      Retrieves the title associated with this object.
      Returns:
      an UnboundLangString representing the title, which may include multiple string values with language attributes

    • setTitle

      public void setTitle(UnboundLangString title)
      Sets the title associated with this object.
      Parameters:
      title - an UnboundLangString representing the title, which may include multiple string values with language attributes

    • getCatalogEntries

      public List<CatalogEntry> getCatalogEntries()
      Retrieves the list of catalog entries associated with the instance.
      Returns:
      a list of CatalogEntry objects representing catalog entries

    • setCatalogEntries

      public void setCatalogEntries(List<CatalogEntry> catalogEntries)
      Sets the list of catalog entries associated with the instance.
      Parameters:
      catalogEntries - a list of CatalogEntry objects representing the catalog entries to be set

    • getLanguage

      public String getLanguage()
      Retrieves the language associated with this object.
      Returns:
      a String representing the language.

    • setLanguage

      public void setLanguage(String language)
      Sets the language associated with this object.
      Parameters:
      language - a String representing the language to be set

    • getDescription

      public UnboundLangString getDescription()
      Retrieves the description associated with this object.
      Returns:
      an UnboundLangString representing the description, which may include multiple string values with language attributes

    • setDescription

      public void setDescription(UnboundLangString description)
      Sets the description for this object.
      Parameters:
      description - an UnboundLangString representing the description, which may include multiple string values with language attributes

    • getKeywords

      public List<UnboundLangString> getKeywords()
      Retrieves the list of keywords associated with this object.
      Returns:
      a list of UnboundLangString objects representing the keywords, which may include multiple string values with language attributes

    • setKeywords

      public void setKeywords(List<UnboundLangString> keywords)
      Sets the list of keywords associated with this object.
      Parameters:
      keywords - a list of UnboundLangString objects representing the keywords, which may include multiple string values with language attributes

    • getCoverage

      public UnboundLangString getCoverage()
      Retrieves the coverage information associated with this object.
      Returns:
      an UnboundLangString representing the coverage, which may include multiple string values with language attributes.

    • setCoverage

      public void setCoverage(UnboundLangString coverage)
      Sets the coverage information associated with this object.
      Parameters:
      coverage - an UnboundLangString representing the coverage, which may include multiple string values with language attributes.

    • getStructure

      public SourceValuePair<Structure> getStructure()
      Retrieves the structure of the learning object associated with this instance.
      Returns:
      a SourceValuePair<Structure> representing the structure, which indicates the organizational form of the learning object.

    • setStructure

      public void setStructure(SourceValuePair<Structure> structure)
      Sets the structure of the learning object associated with this instance.
      Parameters:
      structure - a SourceValuePair<Structure> representing the structure to be set. This indicates the organizational form of the learning object, such as atomic, collection, networked, hierarchical, or linear.

    • getAggregationLevel

      public SourceValuePair<AggregationLevel> getAggregationLevel()
      Retrieves the aggregation level associated with this object.
      Returns:
      a SourceValuePair<AggregationLevel> representing the aggregation level, which specifies the level of granularity or complexity of the learning object.

    • setAggregationLevel

      public void setAggregationLevel(SourceValuePair<AggregationLevel> aggregationLevel)
      Sets the aggregation level for the learning object. The aggregation level specifies the level of granularity or complexity of the learning object.
      Parameters:
      aggregationLevel - a SourceValuePair<AggregationLevel> representing the aggregation level to be set. Possible values include LEVEL_1, LEVEL_2, LEVEL_3, LEVEL_4, or UNKNOWN.

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object