org.faktorips.runtime
Interface IConfigurableModelObject

All Superinterfaces:
IModelObject
All Known Subinterfaces:
ITimedConfigurableModelObject

public interface IConfigurableModelObject
extends IModelObject

Base interface for all model objects that are configurable by a product component.

Author:
Jan Ortmann

Field Summary
static String PROPERTY_PRODUCT_CMPT_GENERATION
          Deprecated. since 3.15, this interface describes configurable model objects that are not changing over time, meaning that they do not support generations. On the other hand, model objects that support this concept are now represented by the new interface ITimedConfigurableModelObject. Use ITimedConfigurableModelObject.PROPERTY_PRODUCT_CMPT_GENERATION instead.
static String PROPERTY_PRODUCT_COMPONENT
          The name of the property 'productComponent'.
 
Method Summary
 Calendar getEffectiveFromAsCalendar()
          Returns the date since when this model object is effective.
 IProductComponentGeneration getProductCmptGeneration()
          Deprecated. since 3.15, this interface describes configurable model objects that are not changing over time, meaning that they do not support generations. On the other hand, model objects that support this concept are now represented by the new interface ITimedConfigurableModelObject. Calling this operation on an object that does not implement ITimedConfigurableModelObject will result in an UnsupportedOperationException.
 IProductComponent getProductComponent()
          Returns the product component this policy component is based on.
 void initialize()
          Initializes the model object with the defaults from it's product component generation.
 
Methods inherited from interface org.faktorips.runtime.IModelObject
validate
 

Field Detail

PROPERTY_PRODUCT_COMPONENT

static final String PROPERTY_PRODUCT_COMPONENT
The name of the property 'productComponent'.

See Also:
Constant Field Values

PROPERTY_PRODUCT_CMPT_GENERATION

@Deprecated
static final String PROPERTY_PRODUCT_CMPT_GENERATION
Deprecated. since 3.15, this interface describes configurable model objects that are not changing over time, meaning that they do not support generations. On the other hand, model objects that support this concept are now represented by the new interface ITimedConfigurableModelObject. Use ITimedConfigurableModelObject.PROPERTY_PRODUCT_CMPT_GENERATION instead.
The name of the property 'productCmptGeneration'.

See Also:
Constant Field Values
Method Detail

getProductComponent

IProductComponent getProductComponent()
Returns the product component this policy component is based on.


getProductCmptGeneration

@Deprecated
IProductComponentGeneration getProductCmptGeneration()
Deprecated. since 3.15, this interface describes configurable model objects that are not changing over time, meaning that they do not support generations. On the other hand, model objects that support this concept are now represented by the new interface ITimedConfigurableModelObject. Calling this operation on an object that does not implement ITimedConfigurableModelObject will result in an UnsupportedOperationException.

Returns the product component generation this policy component is based on.

Throws:
UnsupportedOperationException - if called upon an object that does not implement ITimedConfigurableModelObject

getEffectiveFromAsCalendar

Calendar getEffectiveFromAsCalendar()
Returns the date since when this model object is effective.


initialize

void initialize()
Initializes the model object with the defaults from it's product component generation.



Copyright © 2015. All rights reserved.