Package dev.jcputney.elearning.parser.output.metadata.xapi

Class XapiMetadata

java.lang.Object

dev.jcputney.elearning.parser.output.ModuleMetadata<TincanManifest>

dev.jcputney.elearning.parser.output.metadata.xapi.XapiMetadata

All Implemented Interfaces:

PackageManifest, Serializable

public class XapiMetadata
extends ModuleMetadata<TincanManifest>

Metadata for xAPI/TinCan packaged modules.

TinCan packages contain a single activity and always have xAPI enabled. They do not support multiple launchable units.

See Also:

• Serialized Form

Field Summary

Fields inherited from class dev.jcputney.elearning.parser.output.ModuleMetadata

manifest, moduleEditionType, moduleType, sizeOnDisk, xapiEnabled

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XapiMetadata()	Protected no-argument constructor for XapiMetadata.
	XapiMetadata(TincanManifest manifest)	Constructor for XapiMetadata.

Method Summary

Modifier and Type	Method	Description
String	getManifestFile()	Retrieves the filename of the manifest file for this module.
boolean	hasMultipleLaunchableUnits()	TinCan packages always have a single activity, so this always returns false.

Methods inherited from class dev.jcputney.elearning.parser.output.ModuleMetadata

equals, getDescription, getDuration, getIdentifier, getLaunchUrl, getManifest, getModuleEditionType, getModuleType, getSizeOnDisk, getTitle, getVersion, hashCode, isXapiEnabled, setManifestFile, setSizeOnDisk

Methods inherited from class java.lang.Object

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

Constructor Details

XapiMetadata

protected XapiMetadata()

Protected no-argument constructor for XapiMetadata.

This constructor is primarily used for internal and subclassing purposes. It initializes an instance of XapiMetadata without setting a manifest or other properties.

Instances created using this constructor are expected to be configured manually or used in specific scenarios where the default state is sufficient.

XapiMetadata

public XapiMetadata(TincanManifest manifest)

Constructor for XapiMetadata.

Parameters:

manifest - the TinCan manifest

Method Details

hasMultipleLaunchableUnits

public boolean hasMultipleLaunchableUnits()

TinCan packages always have a single activity, so this always returns false.

Specified by:

hasMultipleLaunchableUnits in class ModuleMetadata<TincanManifest>

Returns:

false

getManifestFile

public String getManifestFile()

Description copied from class: ModuleMetadata

Retrieves the filename of the manifest file for this module.

For most module types, this is a constant defined by the specification (e.g., "imsmanifest.xml" for SCORM, "cmi5.xml" for cmi5). For AICC modules, the filename is discovered during parsing as the .crs file can have any name.

Specified by:

getManifestFile in class ModuleMetadata<TincanManifest>

Returns:

the manifest filename (e.g., "imsmanifest.xml", "cmi5.xml", "course.crs")