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

All Implemented Interfaces:

IModelElement, IModelType

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 Annotation>

Field Summary

Fields

Modifier and Type	Field and Description
static String	KIND_NAME

Constructor Summary

Constructors

Constructor and Description
PolicyCmptType(String name, AnnotatedDeclaration annotatedDeclararation)

Method Summary

Methods

Modifier and Type	Method and Description
PolicyAssociation	getAssociation(String name) Returns the association with the given name declared in this type or one of it's super types.
List<PolicyAssociation>	getAssociations() Returns the type's associations including those defined in it's super types.
PolicyAttribute	getAttribute(String name) Returns the attribute with the given name declared in this type or one of it's super types.
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(String name) Returns the association with the given name declared in this type.
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(String name) Returns the attribute with the given name declared in this type.
List<PolicyAttribute>	getDeclaredAttributes() Returns a list containing all attributes declared in this model type.
protected String	getKindName()
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.
boolean	isConfiguredByPolicyCmptType() Deprecated. Typo in method name. Use isConfiguredByProductCmptType(). Will be removed in 3.19
boolean	isConfiguredByProductCmptType() Returns whether this policy component type is configured by a product component type.

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

getAnnotatedDeclaration, getDeclarationClass, getDeclaredMethods, getJavaClass, getJavaInterface, getMessageHelper, getMessageKey, searchDeclaredMethod, toString

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

Field Detail

KIND_NAME

public static final String KIND_NAME

See Also:

Constant Field Values

Constructor Detail

PolicyCmptType

public PolicyCmptType(String name,
              AnnotatedDeclaration annotatedDeclararation)

Method Detail

getKindName

protected String getKindName()

Specified by:

getKindName in class Type

isConfiguredByPolicyCmptType

@Deprecated
public boolean isConfiguredByPolicyCmptType()

Deprecated. Typo in method name. Use isConfiguredByProductCmptType(). Will be removed in 3.19

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

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:

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 interface IModelType

Specified by:

getSuperType in class Type

getDeclaredAttribute

public PolicyAttribute getDeclaredAttribute(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 interface IModelType

Specified by:

getDeclaredAttribute in class Type

getDeclaredAttribute

public PolicyAttribute getDeclaredAttribute(int index)

Description copied from class: Type

Returns the declared attribute at the given index.

Specified by:

getDeclaredAttribute in interface IModelType

Overrides:

getDeclaredAttribute in class Type

getDeclaredAttributes

public 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 interface IModelType

Specified by:

getDeclaredAttributes in class Type

getAttribute

public PolicyAttribute getAttribute(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.

Specified by:

getAttribute in interface IModelType

Overrides:

getAttribute in class Type

getAttributes

public 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 interface IModelType

Specified by:

getAttributes in class Type

getDeclaredAssociation

public PolicyAssociation getDeclaredAssociation(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 interface IModelType

Specified by:

getDeclaredAssociation in class Type

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.

Specified by:

getDeclaredAssociation in interface IModelType

Overrides:

getDeclaredAssociation in class Type

getDeclaredAssociations

public 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 interface IModelType

Specified by:

getDeclaredAssociations in class Type

getAssociation

public PolicyAssociation getAssociation(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.

Specified by:

getAssociation in interface IModelType

Overrides:

getAssociation in class Type

getAssociations

public 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 interface IModelType

Specified by:

getAssociations in class Type