Package de.xima.fc.workflow.taglib.model

Class BaseDoUntilLoopProps

java.lang.Object

de.xima.fc.workflow.taglib.model.BaseDoUntilLoopProps

All Implemented Interfaces:

IDescriptionProviding, INameProviding, Serializable

Direct Known Subclasses:

BaseMultipleDoUntilLoopTestProps

public class BaseDoUntilLoopProps
extends Object
implements INameProviding, IDescriptionProviding, Serializable

Base class for common properties used by do-until loop nodes. Useful e.g. for plugins that what to implement a custom do-until loop that should behave similarly to a builtin do-until loop, but with a different loop condition test.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Constructor Summary

Constructors

Constructor	Description
BaseDoUntilLoopProps()

Method Summary

Modifier and Type	Method	Description
String	getBeschreibung()	Deprecated. Use getDescription().
String	getDescription()
String	getLabelNo()
String	getLabelYes()
String	getName()
void	setDescription(String description)
void	setLabelNo(String labelNo)
void	setLabelYes(String labelYes)
void	setName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseDoUntilLoopProps

public BaseDoUntilLoopProps()

Method Detail

getBeschreibung

@Deprecated
public final String getBeschreibung()

Deprecated.

Use getDescription().

Specified by:

getBeschreibung in interface IDescriptionProviding

Returns:

The same as getDescription().

getDescription

public final String getDescription()

Specified by:

getDescription in interface IDescriptionProviding

Returns:

A human-readable description for this object.

getLabelNo

@Nullable
public String getLabelNo()

Returns:

The label that is shown on the no branch. Defaults to the localized version of the word no.

getLabelYes

@Nullable
public String getLabelYes()

Returns:

The label that is shown on the yes branch. Defaults to the localized version of the word yes.

getName

public String getName()

Specified by:

getName in interface INameProviding

Returns:

The name of this object.

setDescription

public final void setDescription(String description)

Parameters:

description - An arbitrary description for this action, given by the user.

setLabelNo

public void setLabelNo(String labelNo)

Parameters:

labelNo - The label that is shown on the no branch. Defaults to the localized version of the word no.

setLabelYes

public void setLabelYes(String labelYes)

Parameters:

labelYes - The label that is shown on the yes branch. Defaults to the localized version of the word yes.

setName

public void setName(String name)

Parameters:

name - Name of this loop, for identifying the loop within placeholders.