Package org.faktorips.runtime.model.type

Class Formula

java.lang.Object

org.faktorips.runtime.model.type.ModelElement

org.faktorips.runtime.model.type.TypePart

org.faktorips.runtime.model.type.Formula

public class Formula
extends TypePart

Represents a formula in a ProductCmptType.

Since:

24.7

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSGCODE_REQUIRED_FORMULA_IS_EMPTY
static final String	MSGKEY_REQUIRED_FORMULA_IS_EMPTY
static final String	PROPERTY_REQUIRED_FORMULA

Constructor Summary

Constructors

Constructor	Description
Formula(Type type, Method getter, boolean changingOverTime)

Method Summary

Modifier and Type	Method	Description
String	getFormulaName()	Returns the name of the formula.
String	getFormulaText(IProductComponent productComponent, Calendar effectiveDate)	Returns the formula text of this formula in the given product component.
boolean	isChangingOverTime()	Checks whether this part is changing over time (resides in the generation) or not (resides in the product component).
boolean	isRequired()
void	setFormulaText(IProductComponentGeneration generation, String formulaText)	Sets the formula text of this formula in the given product component.
void	setFormulaText(IProductComponent productComponent, Calendar effectiveDate, String formulaText)	Sets the formula text of this formula in the given product component.
String	toString()
void	validate(MessageList list, IValidationContext context, IProductComponent productComponent, Calendar effectiveDate)	Validates this part's configuration in the given product against the model.

Methods inherited from class org.faktorips.runtime.model.type.TypePart

getMessageHelper, getMessageKey, getModelType, getType, getTypeName

Methods inherited from class org.faktorips.runtime.model.type.ModelElement

createMessageHelper, getDeprecation, getDescription, getDocumentation, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getName, getRelevantProductObject, getRelevantProductObject, invokeField, invokeMethod, isDeprecated

Methods inherited from class java.lang.Object

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

Field Details

MSGCODE_REQUIRED_FORMULA_IS_EMPTY

public static final String MSGCODE_REQUIRED_FORMULA_IS_EMPTY

See Also:

• Constant Field Values

MSGKEY_REQUIRED_FORMULA_IS_EMPTY

public static final String MSGKEY_REQUIRED_FORMULA_IS_EMPTY

See Also:

• Constant Field Values

PROPERTY_REQUIRED_FORMULA

public static final String PROPERTY_REQUIRED_FORMULA

See Also:

• Constant Field Values

Constructor Details

Formula

public Formula(Type type,
 Method getter,
 boolean changingOverTime)

Method Details

isChangingOverTime

public boolean isChangingOverTime()

Description copied from class: TypePart

Checks whether this part is changing over time (resides in the generation) or not (resides in the product component).

Specified by:

isChangingOverTime in class TypePart

Returns:

whether this association is changing over time

getFormulaText

public String getFormulaText(IProductComponent productComponent,
 @CheckForNull
 Calendar effectiveDate)

Returns the formula text of this formula in the given product component.

Parameters:

productComponent - a product component based on the product component type this formula belongs to.

effectiveDate - (optional) the date to use for selecting the product component's generation, if this formula isChangingOverTime()

setFormulaText

public void setFormulaText(IProductComponent productComponent,
 @CheckForNull
 Calendar effectiveDate,
 String formulaText)

Sets the formula text of this formula in the given product component.

Parameters:

productComponent - a product component based on the product component type this formula belongs to.

effectiveDate - (optional) the date to use for selecting the product component's generation, if this formula isChangingOverTime()

formulaText - the new formula text

setFormulaText

public void setFormulaText(IProductComponentGeneration generation,
 String formulaText)

Sets the formula text of this formula in the given product component.

If the formula is not changing over time, the underlying product component is used directly; otherwise, the given generation is used.

Parameters:

generation - the product component generation to base the formula text update on

formulaText - the new formula text

Since:

25.1

getFormulaName

public String getFormulaName()

Returns the name of the formula.

isRequired

public boolean isRequired()

Returns:

true if the formula is required, false otherwise

Since:

25.1

toString

public String toString()

Overrides:

toString in class ModelElement

validate

public void validate(MessageList list,
 IValidationContext context,
 IProductComponent productComponent,
 Calendar effectiveDate)

Description copied from class: TypePart

Validates this part's configuration in the given product against the model.

Overrides:

validate in class TypePart

Parameters:

list - a MessageList, to which validation messages may be added

context - the IValidationContext, needed to determine the Locale in which to create Messages

productComponent - the IProductComponent to validate

effectiveDate - the date that determines which IProductComponentGeneration is to be validated, if the IProductComponent has any and this part is changing over time