Package io.keikai.model.impl

Class ScenarioImpl

java.lang.Object

io.keikai.model.impl.ScenarioImpl

All Implemented Interfaces:

SScenario, Serializable

public class ScenarioImpl
extends Object
implements SScenario, Serializable

Default implementation of SScenario.

Since:

7.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ScenarioImpl(String name)

Method Summary

Modifier and Type	Method	Description
SScenarioInputCell	addInputCell(int row, int col, String value)	Adds an input cell to this scenario.
String	getComment()	Returns the comment/description of this scenario.
List<SScenarioInputCell>	getInputCells()	Returns the list of input cells for this scenario.
String	getName()	Returns the name of this scenario.
String	getUser()	Returns the user who created or last modified this scenario.
boolean	isHidden()	Returns whether this scenario is hidden from the user.
boolean	isLocked()	Returns whether this scenario is locked (cannot be modified when sheet is protected).
void	setComment(String comment)	Sets the comment/description of this scenario.
void	setHidden(boolean hidden)	Sets whether this scenario is hidden from the user.
void	setLocked(boolean locked)	Sets whether this scenario is locked.
void	setName(String name)	Sets the name of this scenario.
void	setUser(String user)	Sets the user who created or last modified this scenario.

Methods inherited from class java.lang.Object

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

Constructor Details

ScenarioImpl

public ScenarioImpl(String name)

Method Details

getName

public String getName()

Description copied from interface: SScenario

Returns the name of this scenario.

Specified by:

getName in interface SScenario

Returns:

the scenario name

setName

public void setName(String name)

Description copied from interface: SScenario

Sets the name of this scenario.

Specified by:

setName in interface SScenario

Parameters:

name - the scenario name

getComment

public String getComment()

Description copied from interface: SScenario

Returns the comment/description of this scenario.

Specified by:

getComment in interface SScenario

Returns:

the comment, or null if not set

setComment

public void setComment(String comment)

Description copied from interface: SScenario

Sets the comment/description of this scenario.

Specified by:

setComment in interface SScenario

Parameters:

comment - the comment text

getUser

public String getUser()

Description copied from interface: SScenario

Returns the user who created or last modified this scenario.

Specified by:

getUser in interface SScenario

Returns:

the user name, or null if not set

setUser

public void setUser(String user)

Description copied from interface: SScenario

Sets the user who created or last modified this scenario.

Specified by:

setUser in interface SScenario

Parameters:

user - the user name

isHidden

public boolean isHidden()

Description copied from interface: SScenario

Returns whether this scenario is hidden from the user.

Specified by:

isHidden in interface SScenario

Returns:

true if hidden

setHidden

public void setHidden(boolean hidden)

Description copied from interface: SScenario

Sets whether this scenario is hidden from the user.

Specified by:

setHidden in interface SScenario

Parameters:

hidden - true to hide

isLocked

public boolean isLocked()

Description copied from interface: SScenario

Returns whether this scenario is locked (cannot be modified when sheet is protected).

Specified by:

isLocked in interface SScenario

Returns:

true if locked

setLocked

public void setLocked(boolean locked)

Description copied from interface: SScenario

Sets whether this scenario is locked.

Specified by:

setLocked in interface SScenario

Parameters:

locked - true to lock

getInputCells

public List<SScenarioInputCell> getInputCells()

Description copied from interface: SScenario

Returns the list of input cells for this scenario.

Specified by:

getInputCells in interface SScenario

Returns:

list of input cells

addInputCell

public SScenarioInputCell addInputCell(int row,
 int col,
 String value)

Description copied from interface: SScenario

Adds an input cell to this scenario.

Specified by:

addInputCell in interface SScenario

Parameters:

row - the row index (0-based)

col - the column index (0-based)

value - the scenario value for this cell

Returns:

the newly created input cell