Package dev.jcputney.elearning.parser.input.scorm2004.ims.ss.rollup

Class RollupAction

java.lang.Object

dev.jcputney.elearning.parser.input.scorm2004.ims.ss.rollup.RollupAction

All Implemented Interfaces:

Serializable

public final class RollupAction
extends Object
implements Serializable

Represents the action to perform if the conditions specified in a rollup rule are met. The rollup action determines how the statuses of child activities affect the parent activity’s rollup status, allowing for complex aggregation logic.

Common actions include marking the parent activity as satisfied, not satisfied, completed, or incomplete based on the rollup rule conditions.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RollupAction()	Default constructor for the RollupAction class.
RollupAction(RollupActionType action)	Initializes a new instance of the RollupAction class with the specified rollup action type.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
RollupActionType	getAction()	Retrieves the current rollup action type associated with this instance.
int	hashCode()
void	setAction(RollupActionType action)	Sets the rollup action to be performed when the rollup rule conditions are met.

Methods inherited from class java.lang.Object

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

Constructor Details

RollupAction

public RollupAction(RollupActionType action)

Initializes a new instance of the RollupAction class with the specified rollup action type.

Parameters:

action - the RollupActionType defining the action to be taken when the conditions of the rollup rule are met. This can include marking the activity as satisfied, not satisfied, completed, or incomplete.

RollupAction

public RollupAction()

Default constructor for the RollupAction class.

Initializes a new instance of the RollupAction class without setting an initial rollup action. This constructor is primarily used for object serialization or other scenarios where the action will be set or modified after instantiation.

Method Details

getAction

public RollupActionType getAction()

Retrieves the current rollup action type associated with this instance.

Returns:

the RollupActionType representing the action to be performed if the rollup rule's conditions are met.

setAction

public void setAction(RollupActionType action)

Sets the rollup action to be performed when the rollup rule conditions are met.

Parameters:

action - the RollupActionType defining the specific action to be taken, such as marking the activity as satisfied, not satisfied, completed, or incomplete.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object