Package dev.jcputney.elearning.parser.validators.rules.cmi5

Class TitleRequiredRule

java.lang.Object

dev.jcputney.elearning.parser.validators.rules.cmi5.TitleRequiredRule

All Implemented Interfaces:

ValidationRule<Cmi5Manifest>

public class TitleRequiredRule
extends Object
implements ValidationRule<Cmi5Manifest>

Validates that a cmi5 course has a title.

According to cmi5 specification, the title element in the course is required and must not be empty.

This rule defers validation when the course is null, as that is handled by CourseRequiredRule.

See Also:

• cmi5 Specification

Constructor Summary

Constructors

Constructor	Description
TitleRequiredRule()

Method Summary

Modifier and Type	Method	Description
String	getRuleName()	Human-readable name of this rule for logging and debugging.
String	getSpecReference()	Specification reference for traceability and documentation.
ValidationResult	validate(Cmi5Manifest manifest)	Validates that the course has a non-empty title.

Methods inherited from class java.lang.Object

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

Constructor Details

TitleRequiredRule

public TitleRequiredRule()

Method Details

validate

public ValidationResult validate(Cmi5Manifest manifest)

Validates that the course has a non-empty title.

Specified by:

validate in interface ValidationRule<Cmi5Manifest>

Parameters:

manifest - The cmi5 manifest to validate (must not be null)

Returns:

ValidationResult containing any issues found

Throws:

IllegalArgumentException - if manifest is null

getRuleName

public String getRuleName()

Description copied from interface: ValidationRule

Human-readable name of this rule for logging and debugging.

Specified by:

getRuleName in interface ValidationRule<Cmi5Manifest>

Returns:

Rule name (e.g., "Resource Reference Validation")

getSpecReference

public String getSpecReference()

Description copied from interface: ValidationRule

Specification reference for traceability and documentation. Used to trace validation back to spec requirements.

Specified by:

getSpecReference in interface ValidationRule<Cmi5Manifest>

Returns:

Spec reference (e.g., "SCORM 1.2 CAM Section 2.3.4")