Class Scorm2004Item
java.lang.Object
dev.jcputney.elearning.parser.input.scorm2004.ims.cp.Scorm2004Item
- All Implemented Interfaces:
Serializable
Represents a single item within an organization, typically mapping to a learning object or
resource. Items define the hierarchical structure within an organization.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanRetrieves the completion threshold for this SCORM 2004 item.getData()Retrieves the ADLData associated with this SCORM 2004 item.Retrieves data associated with this SCORM 2004 item from the LMS.Retrieves the identifier of the current SCORM 2004 item.Retrieves the identifier reference for this SCORM 2004 item.getItems()Retrieves the list of child items associated with this SCORM 2004 item.Retrieves the mastery score for this SCORM 2004 item.Retrieves the metadata associated with this SCORM 2004 item.Retrieves the parameters associated with this SCORM 2004 item.Retrieves the prerequisites for this SCORM 2004 item.Retrieves the presentation settings associated with this SCORM 2004 item.Retrieves the sequencing settings associated with this SCORM 2004 item.Retrieves the time limit action associated with this SCORM 2004 item.getTitle()Retrieves the title of the SCORM 2004 item.inthashCode()booleanDetermines the visibility status of this SCORM 2004 item.voidsetCompletionThreshold(CompletionThreshold completionThreshold) Sets the completion threshold for this SCORM 2004 item.voidSets the ADLData object associated with this SCORM 2004 item.voidsetDataFromLMS(String dataFromLMS) Sets the data associated with this SCORM 2004 item from the LMS.voidsetIdentifier(String identifier) Sets the identifier for this SCORM 2004 item.voidsetIdentifierRef(String identifierRef) Sets the identifier reference for this SCORM 2004 item.voidsetItems(List<Scorm2004Item> items) Sets the list of child items associated with this SCORM 2004 item.voidsetMasteryScore(Double masteryScore) Sets the mastery score for this SCORM 2004 item.voidsetMetadata(Scorm2004SubMetadata metadata) Sets the metadata associated with this SCORM 2004 item.voidsetParameters(String parameters) Sets the parameters associated with this SCORM 2004 item.voidsetPrerequisites(String prerequisites) Sets the prerequisites for this SCORM 2004 item.voidsetPresentation(Presentation presentation) Sets the presentation settings associated with this SCORM 2004 item.voidsetSequencing(Sequencing sequencing) Sets the sequencing settings for this SCORM 2004 item.voidsetTimeLimitAction(TimeLimitAction timeLimitAction) Sets the time limit action for this SCORM 2004 item.voidSets the title for this SCORM 2004 item.voidsetVisible(boolean visible) Sets the visibility status for this SCORM 2004 item.
-
Constructor Details
-
Scorm2004Item
public Scorm2004Item()Default constructor for the Scorm2004Item class. Initializes a new instance of the Scorm2004Item without any specific configuration or data. This constructor is primarily used to create a blank SCORM 2004 item that can later be configured using setter methods.
-
-
Method Details
-
getIdentifier
Retrieves the identifier of the current SCORM 2004 item.- Returns:
- the identifier of this SCORM 2004 item as a
String
-
setIdentifier
Sets the identifier for this SCORM 2004 item.- Parameters:
identifier- the unique identifier to be set for this item
-
getIdentifierRef
Retrieves the identifier reference for this SCORM 2004 item.- Returns:
- the identifier reference as a
String
-
setIdentifierRef
Sets the identifier reference for this SCORM 2004 item.- Parameters:
identifierRef- the identifier reference to be set for this item
-
isVisible
public boolean isVisible()Determines the visibility status of this SCORM 2004 item.- Returns:
- true if the item is visible, false otherwise
-
setVisible
public void setVisible(boolean visible) Sets the visibility status for this SCORM 2004 item.- Parameters:
visible- a boolean value wheretruemakes the item visible, andfalsemakes it invisible
-
getParameters
Retrieves the parameters associated with this SCORM 2004 item.- Returns:
- the parameters of this SCORM 2004 item as a
String
-
setParameters
Sets the parameters associated with this SCORM 2004 item.- Parameters:
parameters- the parameters to be set as aString
-
getTitle
Retrieves the title of the SCORM 2004 item.- Returns:
- the title of this SCORM 2004 item as a
String
-
setTitle
Sets the title for this SCORM 2004 item.- Parameters:
title- the title of the SCORM 2004 item
-
getItems
Retrieves the list of child items associated with this SCORM 2004 item.- Returns:
- a
ListofScorm2004Itemobjects representing the child items
-
setItems
Sets the list of child items associated with this SCORM 2004 item.- Parameters:
items- aListofScorm2004Itemobjects representing the child items
-
getData
Retrieves the ADLData associated with this SCORM 2004 item.- Returns:
- the ADLData object containing the data map elements and configurations
-
setData
Sets the ADLData object associated with this SCORM 2004 item.- Parameters:
data- the ADLData object containing data map elements and configurations
-
getCompletionThreshold
Retrieves the completion threshold for this SCORM 2004 item.- Returns:
- the
CompletionThresholdobject containing the completion threshold settings for this item
-
setCompletionThreshold
Sets the completion threshold for this SCORM 2004 item.- Parameters:
completionThreshold- theCompletionThresholdobject containing the completion threshold settings to be applied to this item
-
getSequencing
Retrieves the sequencing settings associated with this SCORM 2004 item.- Returns:
- the
Sequencingobject defining the sequencing rules and behaviors for this item
-
setSequencing
Sets the sequencing settings for this SCORM 2004 item.- Parameters:
sequencing- theSequencingobject containing the sequencing rules and behaviors to be applied to this item
-
getMetadata
Retrieves the metadata associated with this SCORM 2004 item.- Returns:
- the
Scorm2004SubMetadataobject that encapsulates the metadata for this SCORM 2004 item, which may include inline metadata or an external reference to a metadata file.
-
setMetadata
Sets the metadata associated with this SCORM 2004 item.- Parameters:
metadata- theScorm2004SubMetadataobject containing the metadata for this SCORM 2004 item, which may include inline metadata or an external reference to a metadata file
-
getPresentation
Retrieves the presentation settings associated with this SCORM 2004 item.- Returns:
- the
Presentationobject containing the navigation control settings, or null if no presentation settings are defined
-
getMasteryScore
Retrieves the mastery score for this SCORM 2004 item.- Returns:
- the mastery score as a
Double, or null if no mastery score is defined
-
setMasteryScore
Sets the mastery score for this SCORM 2004 item.- Parameters:
masteryScore- the mastery score to be set as aDouble
-
getPrerequisites
Retrieves the prerequisites for this SCORM 2004 item.- Returns:
- the prerequisites as a
String
-
setPrerequisites
Sets the prerequisites for this SCORM 2004 item.- Parameters:
prerequisites- the prerequisites to be set, represented as aString
-
getTimeLimitAction
Retrieves the time limit action associated with this SCORM 2004 item. TheTimeLimitActionspecifies how the system should behave when a time limit is exceeded, such as exiting or continuing the activity with or without a message.- Returns:
- the
TimeLimitActionassociated with this SCORM 2004 item, orTimeLimitAction.UNKNOWNif no action is defined.
-
setTimeLimitAction
Sets the time limit action for this SCORM 2004 item. TheTimeLimitActionspecifies how the system should behave when the time limit is exceeded, such as exiting or continuing the activity with or without a message.- Parameters:
timeLimitAction- theTimeLimitActionto be set for this SCORM 2004 item, which defines the system's behavior on exceeding the time limit
-
getDataFromLMS
Retrieves data associated with this SCORM 2004 item from the LMS.- Returns:
- the data from the LMS as a
String
-
setDataFromLMS
Sets the data associated with this SCORM 2004 item from the LMS.- Parameters:
dataFromLMS- the data from the LMS to be set as aString
-
equals
-
hashCode
public int hashCode()
-