Package org.faktorips.runtime.model.type

Class PolicyCmptType

java.lang.Object

org.faktorips.runtime.model.type.ModelElement

org.faktorips.runtime.model.type.Type

org.faktorips.runtime.model.type.PolicyCmptType

public class PolicyCmptType
extends Type

Corresponds to a design time IPolicyCmptType.

Nested Class Summary

Nested classes/interfaces inherited from class org.faktorips.runtime.model.type.Type

Type.AnnotatedElementMatcher<T extends java.lang.annotation.Annotation>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	KIND_NAME

Constructor Summary

Constructors

Constructor	Description
PolicyCmptType(java.lang.String name, AnnotatedDeclaration annotatedDeclararation)

Method Summary

Modifier and Type	Method	Description
java.util.Optional<PolicyCmptType>	findSuperType()	Returns this type's super type if present, otherwise an empty Optional.
PolicyAssociation	getAssociation(java.lang.String name)	Returns the association with the given name declared in this type or one of it's super types.
java.util.List<PolicyAssociation>	getAssociations()	Returns the type's associations including those defined in it's super types.
PolicyAttribute	getAttribute(java.lang.String name)	Returns the attribute with the given name declared in this type or one of it's super types.
java.util.List<PolicyAttribute>	getAttributes()	Returns a list containing the type's attributes including those defined in the type's super types.
PolicyAssociation	getDeclaredAssociation(int index)	Returns the association at the given index.
PolicyAssociation	getDeclaredAssociation(java.lang.String name)	Returns the association with the given name declared in this type.
java.util.List<PolicyAssociation>	getDeclaredAssociations()	Returns a list containing all associations declared in this type.
PolicyAttribute	getDeclaredAttribute(int index)	Returns the declared attribute at the given index.
PolicyAttribute	getDeclaredAttribute(java.lang.String name)	Returns the attribute with the given name declared in this type.
java.util.List<PolicyAttribute>	getDeclaredAttributes()	Returns a list containing all attributes declared in this model type.
ValidationRule	getDeclaredValidationRule(int index)	Returns the declared ValidationRule at the given index.
ValidationRule	getDeclaredValidationRule(java.lang.String name)	Returns the ValidationRule with the given name declared in this type.
java.util.List<ValidationRule>	getDeclaredValidationRules()	Returns a list containing all ValidationRules declared in this model type.
protected java.lang.String	getKindName()
java.util.List<ModelObjectAttribute>	getModelObjectAttributes(IModelObject modelObject)	Returns a list with ModelObjectAttributes with all getAttributes() of this PolicyCmptType
ProductCmptType	getProductCmptType()	Returns the ProductCmptType that configures this policy component type.
PolicyCmptType	getSuperType()	Returns this type's super type or null if it has none.
ValidationRule	getValidationRule(java.lang.String name)	Returns the ValidationRule with the given name declared in this type or one of its super types.
java.util.List<ValidationRule>	getValidationRules()	Returns a list containing all the ValidationRules including those defined in the super types.
boolean	isAssociationDeclared(java.lang.String name)	Returns whether the association with the given name is declared in this type.
boolean	isAttributeDeclared(java.lang.String name)	Returns whether the attribute with the given name is declared in this type.
boolean	isConfiguredByProductCmptType()	Returns whether this policy component type is configured by a product component type.
boolean	isValidationRuleDeclared(java.lang.String name)	Returns whether the ValidationRule with the given name is declared in this type.

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

findDeclaredField, findDeclaredMethod, findJavaInterface, getAnnotatedDeclaration, getDeclarationClass, getDeclaredFields, getDeclaredMethods, getJavaClass, getJavaInterface, getMessageHelper, getMessageKey, isAssociationPresent, isAttributePresent, isSuperTypePresent, searchDeclaredMethod, toString

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

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

Methods inherited from class java.lang.Object

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

Field Detail

KIND_NAME

public static final java.lang.String KIND_NAME

See Also:

Constant Field Values

Constructor Detail

PolicyCmptType

public PolicyCmptType(java.lang.String name,
                      AnnotatedDeclaration annotatedDeclararation)

Method Detail

getKindName

protected java.lang.String getKindName()

Specified by:

getKindName in class Type

isConfiguredByProductCmptType

public boolean isConfiguredByProductCmptType()

Returns whether this policy component type is configured by a product component type. If this method returns true you could use getProductCmptType() to get the type of the configuring product.

Returns:

true if this policy component type is configured else false

getProductCmptType

public ProductCmptType getProductCmptType()

Returns the ProductCmptType that configures this policy component type. Throws an IllegalArgumentException if this policy component type is not configured. Use isConfiguredByProductCmptType() to check whether it is configured or not.

Returns:

the ProductCmptType that configures this policy component type

Throws:

java.lang.NullPointerException - if this policy component type is not configured

getSuperType

public PolicyCmptType getSuperType()

Description copied from class: Type

Returns this type's super type or null if it has none.

Specified by:

getSuperType in class Type

See Also:

findSuperType for null-safe processing

findSuperType

public java.util.Optional<PolicyCmptType> findSuperType()

Description copied from class: Type

Returns this type's super type if present, otherwise an empty Optional.

Overrides:

findSuperType in class Type

getDeclaredAttribute

public PolicyAttribute getDeclaredAttribute(java.lang.String name)

Description copied from class: Type

Returns the attribute with the given name declared in this type. Attributes defined in the type's super types are not returned.

Specified by:

getDeclaredAttribute in class Type

Parameters:

name - the name of the attribute

Returns:

the attribute if it was found in this type

See Also:

Type.isAttributeDeclared(String)

getDeclaredAttribute

public PolicyAttribute getDeclaredAttribute(int index)

Description copied from class: Type

Returns the declared attribute at the given index.

Overrides:

getDeclaredAttribute in class Type

getDeclaredAttributes

public java.util.List<PolicyAttribute> getDeclaredAttributes()

Description copied from class: Type

Returns a list containing all attributes declared in this model type. Attributes defined in the type's super types are not returned.

Specified by:

getDeclaredAttributes in class Type

Returns:

the list of attributes declared in this type

getAttribute

public PolicyAttribute getAttribute(java.lang.String name)

Description copied from class: Type

Returns the attribute with the given name declared in this type or one of it's super types.

Overrides:

getAttribute in class Type

getAttributes

public java.util.List<PolicyAttribute> getAttributes()

Description copied from class: Type

Returns a list containing the type's attributes including those defined in the type's super types.

Specified by:

getAttributes in class Type

Returns:

the list of all attributes declared in this type or in any supertype

getModelObjectAttributes

public java.util.List<ModelObjectAttribute> getModelObjectAttributes(IModelObject modelObject)

Returns a list with ModelObjectAttributes with all getAttributes() of this PolicyCmptType

Parameters:

modelObject - the IModelObject linked to the attributes

Returns:

a list with ModelObjectAttributes

Since:

21.6

getDeclaredAssociation

public PolicyAssociation getDeclaredAssociation(java.lang.String name)

Description copied from class: Type

Returns the association with the given name declared in this type. Associations defined in the type's super types are not considered. The name could either be the singular or the plural name.

Specified by:

getDeclaredAssociation in class Type

Parameters:

name - the name of the association

Returns:

the association if it was found in this type

See Also:

Type.isAssociationDeclared(String)

getDeclaredAssociation

public PolicyAssociation getDeclaredAssociation(int index)

Description copied from class: Type

Returns the association at the given index. Associations defined in the type's super types are not returned.

Overrides:

getDeclaredAssociation in class Type

getDeclaredAssociations

public java.util.List<PolicyAssociation> getDeclaredAssociations()

Description copied from class: Type

Returns a list containing all associations declared in this type. Associations defined in the type's super types are not returned.

Specified by:

getDeclaredAssociations in class Type

Returns:

the list of associations declared in this type

getAssociation

public PolicyAssociation getAssociation(java.lang.String name)

Description copied from class: Type

Returns the association with the given name declared in this type or one of it's super types. The name could either be the singular or the plural name.

Overrides:

getAssociation in class Type

getAssociations

public java.util.List<PolicyAssociation> getAssociations()

Description copied from class: Type

Returns the type's associations including those defined in it's super types.

Specified by:

getAssociations in class Type

Returns:

the list of all associations declared in this type or in any super type

isAssociationDeclared

public boolean isAssociationDeclared(java.lang.String name)

Description copied from class: Type

Returns whether the association with the given name is declared in this type. Associations defined in the type's super types are not considered.

Specified by:

isAssociationDeclared in class Type

Parameters:

name - the name of the association

Returns:

true if the association is declared in this type, false if not

See Also:

Type.isAssociationPresent(String)

isAttributeDeclared

public boolean isAttributeDeclared(java.lang.String name)

Description copied from class: Type

Returns whether the attribute with the given name is declared in this type. Attributes defined in the type's super types are not considered.

Specified by:

isAttributeDeclared in class Type

Parameters:

name - the name of the attribute

Returns:

true if the attribute is declared in this type, false if not

getDeclaredValidationRule

public ValidationRule getDeclaredValidationRule(java.lang.String name)

Returns the ValidationRule with the given name declared in this type. ValidationRules defined in the type's super types is not returned.

Parameters:

name - the name of the ValidationRule

Returns:

ValidationRule with the given name if it was found in this type

Throws:

java.lang.IllegalArgumentException - if no ValidationRule with the given name exists

getDeclaredValidationRule

public ValidationRule getDeclaredValidationRule(int index)

Returns the declared ValidationRule at the given index.

Parameters:

index - the position at which the ValidationRule is expected in the list of declared ValidationRules

Returns:

the declared ValidationRule at the given index

Throws:

java.lang.IndexOutOfBoundsException - if no ValidationRule exists for the given index

getDeclaredValidationRules

public java.util.List<ValidationRule> getDeclaredValidationRules()

Returns a list containing all ValidationRules declared in this model type. ValidationRules defined in the type's super types are not returned.

Returns:

the list of ValidationRules declared in this type

getValidationRule

public ValidationRule getValidationRule(java.lang.String name)

Returns the ValidationRule with the given name declared in this type or one of its super types.

Parameters:

name - the name of the ValidationRule

Returns:

ValidationRule with the given name declared in this type or one of its super types

Throws:

java.lang.IllegalArgumentException - if no ValidationRule with the given name exists

getValidationRules

public java.util.List<ValidationRule> getValidationRules()

Returns a list containing all the ValidationRules including those defined in the super types.

Returns:

the list of all ValidationRules declared in this type and in its super types

isValidationRuleDeclared

public boolean isValidationRuleDeclared(java.lang.String name)

Returns whether the ValidationRule with the given name is declared in this type. ValidationRules defined in the type's super types are not considered.

Parameters:

name - the name of the ValidationRule

Returns:

true if the ValidationRule is declared in this type, false if not