org.faktorips.runtime

Interface IProductObject

All Superinterfaces:

IProductComponentLinkSource

All Known Subinterfaces:

IProductComponent, IProductComponentGeneration

All Known Implementing Classes:

ProductComponent, ProductComponentGeneration

public interface IProductObject
extends IProductComponentLinkSource

Common interface for IProductComponent and IProductComponentGeneration.

Method Summary

Modifier and Type	Method and Description
IConfigurableModelObject	createPolicyComponent() Creates a new policy component that is configured by this product component generation.
DateTime	getValidFrom() Returns the date from which this generation is valid.
Date	getValidFrom(TimeZone zone) Returns the point in time this generation is valid from in the given time zone.
boolean	isValidationRuleActivated(String ruleName) Returns whether the validation rule with the given name is configured as active in this IProductObject.
void	setValidationRuleActivated(String ruleName, boolean active) Enables or disables validation for a specific rule.

Methods inherited from interface org.faktorips.runtime.IProductComponentLinkSource

getLink, getLinks, getRepository

Method Detail

createPolicyComponent

IConfigurableModelObject createPolicyComponent()

Creates a new policy component that is configured by this product component generation. After creating the policy component it is automatically initialized. The new policy component is not added to any parent structure.

Throws:

RuntimeException - if this product component does not configure a policy component.

getValidFrom

DateTime getValidFrom()

Returns the date from which this generation is valid.

Returns:

The valid from date of this generation

getValidFrom

Date getValidFrom(TimeZone zone)

Returns the point in time this generation is valid from in the given time zone. This method never returns null.

Throws:

NullPointerException - if zone is null.

isValidationRuleActivated

boolean isValidationRuleActivated(String ruleName)

Returns whether the validation rule with the given name is configured as active in this IProductObject. If there is no configuration for the given rule, false is returned.

Please be aware that only one of IProductComponent or IProductComponentGeneration can configure any given rule depending on its changing-over-time configuration.

Parameters:

ruleName - the name of the rule in question

Returns:

true if the rule was activated, false else.

Since:

3.22

setValidationRuleActivated

void setValidationRuleActivated(String ruleName,
                                boolean active)

Enables or disables validation for a specific rule.

Parameters:

ruleName - the name of the rule in question

active - indicating whether the validation rule is configured as active

Throws:

IllegalRepositoryModificationException - if the IRuntimeRepository containing this IProductObject is not modifiable

Since:

3.22