org.faktorips.runtime.model.type

Class ProductAssociation

java.lang.Object

org.faktorips.runtime.model.type.ModelElement

org.faktorips.runtime.model.type.TypePart

org.faktorips.runtime.model.type.Association

org.faktorips.runtime.model.type.ProductAssociation

All Implemented Interfaces:

IModelElement, IModelTypeAssociation

public class ProductAssociation
extends Association

Nested Class Summary

Nested classes/interfaces inherited from interface org.faktorips.runtime.modeltype.IModelTypeAssociation

IModelTypeAssociation.AssociationType

Constructor Summary

Constructors

Constructor and Description
ProductAssociation(Type type, Method getterMethod, Method addMethod, Method addMethodWithCardinality, Method removeMethod, boolean changingOverTime, Method getLinksMethod)

Method Summary

Modifier and Type	Method and Description
<S extends IProductComponent> S	addTargetObject(S source, Calendar effectiveDate, IProductComponent target, CardinalityRange cardinality) Adds the target object with the given cardinality to this association in the source object.
<S extends IProductComponent> S	addTargetObjects(S source, Calendar effectiveDate, Collection<IProductComponent> targets) Adds the target objects to this association in the source object.
<S extends IProductComponent> S	addTargetObjects(S source, Calendar effectiveDate, IProductComponent... targets) Adds the target objects to this association in the source object.
ProductAssociation	createOverwritingAssociationFor(Type subType)
<T extends IProductComponent> Collection<IProductComponentLink<T>>	getLinks(IProductComponent prodCmpt, Calendar effectiveDate) Retrieves all links for this association from a product component.
PolicyCmptType	getMatchingAssociationSourceType() Returns the PolicyCmptType identified by Association.getMatchingAssociationSource()
ProductCmptType	getModelType() Deprecated. Use getType()
ProductAssociation	getSuperAssociation() Returns the association that is overridden by this association if this association overrides another one.
ProductCmptType	getTarget() Returns the target type of this association.
List<IProductComponent>	getTargetObjects(IProductComponent productComponentSource, Calendar effectiveDate) Returns a list of the target(s) of the given product component's association identified by this model type association.
ProductCmptType	getType() Returns the ProductCmptType this association belongs to.
boolean	isChangingOverTime() Checks whether this association is changing over time (resides in the generation) or not (resides in the product component).
<S extends IProductComponent> S	removeTargetObjects(S source, Calendar effectiveDate, IProductComponent... targetsToRemove) Removes the target object from this association in the source object.
<S extends IProductComponent> S	removeTargetObjects(S source, Calendar effectiveDate, List<IProductComponent> targetsToRemove) Removes the target object from this association in the source object.

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

getAssociationKind, getAssociationType, getGetterMethod, getInverseAssociation, getLabelForPlural, getMatchingAssociation, getMatchingAssociationName, getMatchingAssociationSource, getMaxCardinality, getMinCardinality, getNamePlural, getUsedName, isDerivedUnion, isMatchingAssociationPresent, isOverriding, isProductRelevant, isSubsetOfADerivedUnion, isToOneAssociation, toString

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

getMessageHelper, getMessageKey, getTypeName

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.faktorips.runtime.modeltype.IModelElement

getDescription, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getName

Constructor Detail

ProductAssociation

public ProductAssociation(Type type,
                          Method getterMethod,
                          Method addMethod,
                          Method addMethodWithCardinality,
                          Method removeMethod,
                          boolean changingOverTime,
                          Method getLinksMethod)

Method Detail

createOverwritingAssociationFor

public ProductAssociation createOverwritingAssociationFor(Type subType)

Specified by:

createOverwritingAssociationFor in class Association

getType

public ProductCmptType getType()

Returns the ProductCmptType this association belongs to.

Overrides:

getType in class TypePart

getModelType

@Deprecated
public ProductCmptType getModelType()

Deprecated. Use getType()

Returns the model type this association belongs to.

Specified by:

getModelType in interface IModelTypeAssociation

Overrides:

getModelType in class TypePart

getTarget

public ProductCmptType getTarget()

Returns the target type of this association.

Specified by:

getTarget in interface IModelTypeAssociation

Overrides:

getTarget in class Association

getTargetObjects

public List<IProductComponent> getTargetObjects(IProductComponent productComponentSource,
                                                Calendar effectiveDate)

Returns a list of the target(s) of the given product component's association identified by this model type association. If this association is changing over time (resides in the generation) the date is used to retrieve the correct generation. If the date is null the latest generation is used. If the association is not changing over time the date will be ignored.

Parameters:

productComponentSource - a product object corresponding to the ProductCmptType this association belongs to

effectiveDate - The date that should be used to get the IProductComponentGeneration if this association is changing over time. May be null to get the latest generation.

Returns:

a list of the target(s) of the given model object's association identified by this model type association

Throws:

IllegalArgumentException - if the model object does not have an association fitting this model type association or that association is not accessible for any reason

addTargetObjects

public <S extends IProductComponent> S addTargetObjects(S source,
                                                        Calendar effectiveDate,
                                                        Collection<IProductComponent> targets)

Adds the target objects to this association in the source object. If this is a ..1 ("to one") association, the target object is set (and thus the potentially existing object is overwritten).

The return value is the updated source object. It could be used to directly create a tree of objects. For example with a model like:

 
 SalesProduct <>---- Product <>---- CoverageType
 
 

You could write such code:

 
      products.addTargetObjects(salesProduct,
          coveragetypes.addTargetObjects(product,
              coverageType1, coverageType2));
 
 

Parameters:

source - the object to add a target object to

effectiveDate - The date that should be used to get the IProductComponentGeneration if this association is changing over time. May be null to get the latest generation.

targets - the objects to add to source

Returns:

the changed source object

Throws:

IllegalArgumentException - if there is no method annotated with @IpsAssociationAdder. This is the case if the association is a derived union.

IllegalArgumentException - if there are multiple target objects provided for a ..1 ("to one") association

Since:

20.6

addTargetObjects

public <S extends IProductComponent> S addTargetObjects(S source,
                                                        Calendar effectiveDate,
                                                        IProductComponent... targets)

Adds the target objects to this association in the source object. If this is a ..1 ("to one") association, the target object is set (and thus the potentially existing object is overwritten).

The return value is the updated source object. It could be used to directly create a tree of objects. For example with a model like:

 
 SalesProduct <>---- Product <>---- CoverageType
 
 

You could write such code:

 
      products.addTargetObjects(salesProduct,
          coveragetypes.addTargetObjects(product,
              coverageType1, coverageType2));
 
 

Parameters:

source - the object to add a target object to

effectiveDate - the date that should be used to get the IProductComponentGeneration if this association is changing over time. May be null to get the latest generation.

targets - the objects to add to source

Returns:

the changed source object

Throws:

IllegalArgumentException - if there is no method annotated with @IpsAssociationAdder. This is the case if the association is a derived union.

IllegalArgumentException - if there are multiple target objects provided for a ..1 ("to one") association

Since:

20.6

addTargetObject

public <S extends IProductComponent> S addTargetObject(S source,
                                                       Calendar effectiveDate,
                                                       IProductComponent target,
                                                       CardinalityRange cardinality)

Adds the target object with the given cardinality to this association in the source object. If this is a ..1 ("to one") association, the target object is set (and thus the potentially existing object is overwritten).

The return value is the updated source object. It could be used to directly create a tree of objects. For example with a model like:

 
 SalesProduct <>---- Product <>---- CoverageType
 
 

You could write such code:

 
      products.addTargetObject(salesProduct,
          coveragetypes.addTargetObject(product,
              coverageType));
 
 

Parameters:

source - the object to add a target object to

effectiveDate - the date that should be used to get the IProductComponentGeneration if this association is changing over time. May be null to get the latest generation.

target - the object to add to source

cardinality - the cardinality range that will be set for the target

Returns:

the changed source object

Throws:

IllegalArgumentException - if there is no method annotated with @IpsAssociationAdder. This is the case if the association is a derived union.

IllegalArgumentException - if there are multiple target objects provided for a ..1 ("to one") association

Since:

20.6

removeTargetObjects

public <S extends IProductComponent> S removeTargetObjects(S source,
                                                           Calendar effectiveDate,
                                                           List<IProductComponent> targetsToRemove)

Removes the target object from this association in the source object. Does nothing if the target object is not currently referenced (in this association). Sets to null if this is a ..1 ("to one") association.

The return value is the updated source object. It could be used to directly remove objects in a tree of objects. For example with a model like:

 
 SalesProduct <>---- Product <>---- CoverageType
 
 

You could write such code:

 
      products.removeTargetObjects(SalesProduct,
          coverageTypes.removeTargetObjects(product,
              coverageType1, coverageType2));
 
 

Parameters:

source - the object to remove a target object from

effectiveDate - the date that should be used to get the IProductComponentGeneration if this association is changing over time. May be null to get the latest generation.

targetsToRemove - the objects to remove from this association in source

Returns:

the changed source object

Throws:

IllegalArgumentException - if there is no method annotated with @IpsAssociationRemover (or @IpsAssociationAdder for a ..1 association). This is the case if the association is a derived union.

IllegalArgumentException - if there are multiple or no target objects provided for a ..1 ("to one") association

Since:

20.6

removeTargetObjects

public <S extends IProductComponent> S removeTargetObjects(S source,
                                                           Calendar effectiveDate,
                                                           IProductComponent... targetsToRemove)

Removes the target object from this association in the source object. Does nothing if the target object is not currently referenced (in this association). Sets to null if this is a ..1 ("to one") association.

The return value is the updated source object. It could be used to directly remove objects in a tree of objects. For example with a model like:

 
 SalesProduct <>---- Product <>---- CoverageType
 
 

You could write such code:

 
      products.removeTargetObjects(SalesProduct,
          coverageTypes.removeTargetObjects(product,
              coverageType1, coverageType2));
 
 

Parameters:

source - the object to remove a target object from

effectiveDate - the date that should be used to get the IProductComponentGeneration if this association is changing over time. May be null to get the latest generation.

targetsToRemove - the objects to remove from this association in source

Returns:

the changed source object

Throws:

IllegalArgumentException - if there is no method annotated with @IpsAssociationRemover (or @IpsAssociationAdder for a ..1 association). This is the case if the association is a derived union.

IllegalArgumentException - if there are multiple or no target objects provided for a ..1 ("to one") association

Since:

20.6

getMatchingAssociationSourceType

public PolicyCmptType getMatchingAssociationSourceType()

Returns the PolicyCmptType identified by Association.getMatchingAssociationSource()

Specified by:

getMatchingAssociationSourceType in interface IModelTypeAssociation

Overrides:

getMatchingAssociationSourceType in class Association

Returns:

The policy component type of the matching association source

See Also:

Association.getMatchingAssociationSource()

isChangingOverTime

public boolean isChangingOverTime()

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

Returns:

true if this association is changing over time, else false

getLinks

public <T extends IProductComponent> Collection<IProductComponentLink<T>> getLinks(IProductComponent prodCmpt,
                                                                                   Calendar effectiveDate)

Retrieves all links for this association from a product component.

Parameters:

prodCmpt - the source product component to retrieve the links from

effectiveDate - the effective-date of the adjustment (a.k.a. product component generation). Ignored if this is a static association (isChangingOverTime()==false).

Returns:

the list of all link instances defined in the product component for this association. Returns a list with a single link instance for ..1 associations.

Throws:

IllegalArgumentException - if there is no method annotated with @IpsAssociationLinks. This is the case if the association is a derived union.

Since:

3.22

getSuperAssociation

public ProductAssociation getSuperAssociation()

Description copied from class: Association

Returns the association that is overridden by this association if this association overrides another one. Otherwise returns null.

Overrides:

getSuperAssociation in class Association

Returns:

The association that is overridden by this attribute.

See Also:

Association.isOverriding()