Package org.faktorips.runtime.model.type

Class ModelObjectAttribute

java.lang.Object

org.faktorips.runtime.model.type.ModelObjectAttribute

public class ModelObjectAttribute
extends java.lang.Object

A ModelObjectAttribute combines a PolicyAttribute with a specific IModelObject of the PolicyCmptType the PolicyAttribute belongs to and provides convenience methods to query and modify that combination.

Since:

21.6

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getDefaultValue()	Returns the product configured default value of the attribute identified by this model object attribute.
IModelObject	getModelObject()
PolicyAttribute	getPolicyAttribute()
java.lang.Object	getValue()	Returns the value of the this model object attribute.
org.faktorips.valueset.ValueSet<?>	getValueSet()	Returns the set of values allowed for this model object attribute.
boolean	isEmpty()	Checks whether this model object attribute is empty.
boolean	isIrrelevant()	Returns whether this attribute is considered Relevance.IRRELEVANT.
boolean	isMandatory()	Returns whether this attribute is considered Relevance.MANDATORY.
boolean	isOptional()	Returns whether this attribute is considered Relevance.OPTIONAL.
boolean	isRelevant()	Returns whether this attribute is considered relevant.
boolean	isValuePresent()	Checks whether this model object attribute has a non-empty value.
static ModelObjectAttribute	of(IModelObject modelObject, java.lang.String attributeName)	Creates a ModelObjectAttribute for the given model object and policy attribute.
static ModelObjectAttribute	of(IModelObject modelObject, PolicyAttribute policyAttribute)	Creates a ModelObjectAttribute for the given model object and policy attribute.
ModelObjectAttribute	removeValue()	Sets the model object attribute to its null-value (null for most datatypes, a NullObject for for the NullObjectSupport-datatypes Decimal and Money, and an empty string for the datatype String) This only works for changeable attributes.
ModelObjectAttribute	setDefaultValue(java.lang.Object defaultValue)	Sets the product configured default value of this attribute.
ModelObjectAttribute	setValueSet(org.faktorips.valueset.ValueSet<?> valueSet)	Sets the product configured set of allowed values of this model object attribute.
ObjectProperty	toObjectProperty()	Returns an ObjectProperty for this model object attribute.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static final ModelObjectAttribute of(@NonNull
                                            IModelObject modelObject,
                                            @NonNull
                                            PolicyAttribute policyAttribute)

Creates a ModelObjectAttribute for the given model object and policy attribute.

Parameters:

modelObject - a model object instance of the PolicyCmptType the PolicyAttribute belongs to

policyAttribute - a policy attribute

Throws:

java.lang.IllegalArgumentException - if the PolicyAttribute belongs to a PolicyCmptType the IModelObject is not an instance of

of

public static final ModelObjectAttribute of(@NonNull
                                            IModelObject modelObject,
                                            @NonNull
                                            java.lang.String attributeName)

Creates a ModelObjectAttribute for the given model object and policy attribute.

Parameters:

modelObject - a model object

attributeName - the name of a PolicyAttribute of the model object's PolicyCmptType

getModelObject

public IModelObject getModelObject()

getPolicyAttribute

public PolicyAttribute getPolicyAttribute()

getValue

public java.lang.Object getValue()

Returns the value of the this model object attribute.

Throws:

java.lang.IllegalArgumentException - if the attribute is not accessible for any reason

See Also:

PolicyAttribute.getValue(IModelObject)

isValuePresent

public boolean isValuePresent()

Checks whether this model object attribute has a non-empty value.

See Also:

PolicyAttribute.isValuePresent(IModelObject)

isEmpty

public boolean isEmpty()

Checks whether this model object attribute is empty.

Returns:

true if empty

See Also:

PolicyAttribute.isEmpty(IModelObject)

removeValue

public ModelObjectAttribute removeValue()

Sets the model object attribute to its null-value (null for most datatypes, a NullObject for for the NullObjectSupport-datatypes Decimal and Money, and an empty string for the datatype String) This only works for changeable attributes.

Returns:

this ModelObjectAttribute, to allow method chaining.

Throws:

java.lang.IllegalArgumentException - if the model object attribute is not accessible for any reason.

java.lang.UnsupportedOperationException - if invoked on a AttributeKind.CONSTANT attribute.

See Also:

PolicyAttribute.removeValue(IModelObject)

getValueSet

public org.faktorips.valueset.ValueSet<?> getValueSet()

Returns the set of values allowed for this model object attribute.

Throws:

java.lang.UnsupportedOperationException - if invoked on a AttributeKind.CONSTANT attribute.

java.lang.IllegalStateException - if the method that should return a value set for this attribute has too many arguments

java.lang.IllegalArgumentException - if the invocation of the method that should return a value set for this attribute fails for any reason

See Also:

PolicyAttribute.getValueSet(IModelObject)

setValueSet

public ModelObjectAttribute setValueSet(org.faktorips.valueset.ValueSet<?> valueSet)

Sets the product configured set of allowed values of this model object attribute.

Caution: as generics are erased at runtime, it is possible to set a ValueSet of a mismatched type with this method, for example an OrderedValueSet<String> for an attribute with datatype Integer, which will result in a ClassCastException on later method calls.

Parameters:

valueSet - the new value set

Returns:

this ModelObjectAttribute, to allow method chaining.

Throws:

java.lang.UnsupportedOperationException - if invoked on a AttributeKind.CONSTANT attribute.

java.lang.ClassCastException - if the type of value set does not match the property's configuration or the model object is no IConfigurableModelObject.

java.lang.IllegalStateException - if the model object has no setter method for this attribute's value set. This also occurs if the corresponding policy class is not configured by a product class.

java.lang.IllegalArgumentException - if the invocation of the method that should set the value set for this attribute fails for any reason

See Also:

PolicyAttribute.setValueSet(IConfigurableModelObject, ValueSet)

getDefaultValue

public java.lang.Object getDefaultValue()

Returns the product configured default value of the attribute identified by this model object attribute. Throws an IllegalStateException if the model object has no getDefaultValue() method for this attribute. This also occurs if the corresponding policy class is not configured by a product class.

Throws:

java.lang.IllegalStateException - if the model object has no getter method for this attribute's default value. This also occurs if the corresponding policy class is not configured by a product class.

java.lang.IllegalArgumentException - if the invocation of the method that should get the default value for this attribute fails for any reason

java.lang.ClassCastException - if the model object is no IConfigurableModelObject.

See Also:

PolicyAttribute.getDefaultValue(IModelObject)

setDefaultValue

public ModelObjectAttribute setDefaultValue(java.lang.Object defaultValue)

Sets the product configured default value of this attribute. necessary) effective date can be retrieved

Parameters:

defaultValue - the new default value

Returns:

this ModelObjectAttribute, to allow method chaining.

Throws:

java.lang.UnsupportedOperationException - if invoked on a AttributeKind.CONSTANT attribute.

java.lang.IllegalStateException - if the model object has no setter method for this attribute's default value. This also occurs if the corresponding policy class is not configured by a product class.

java.lang.IllegalArgumentException - if the invocation of the method that should set the default value for this attribute fails for any reason

java.lang.ClassCastException - if the model object is no IConfigurableModelObject.

See Also:

PolicyAttribute.setDefaultValue(IConfigurableModelObject, Object)

isIrrelevant

public boolean isIrrelevant()

Returns whether this attribute is considered Relevance.IRRELEVANT.

See Also:

Relevance.isIrrelevant(IModelObject, PolicyAttribute)

isRelevant

public boolean isRelevant()

Returns whether this attribute is considered relevant.

See Also:

Relevance.isRelevant(IModelObject, PolicyAttribute)

isMandatory

public boolean isMandatory()

Returns whether this attribute is considered Relevance.MANDATORY.

See Also:

Relevance.isMandatory(IModelObject, PolicyAttribute)

isOptional

public boolean isOptional()

Returns whether this attribute is considered Relevance.OPTIONAL.

See Also:

Relevance.isOptional(IModelObject, PolicyAttribute)

toObjectProperty

public ObjectProperty toObjectProperty()

Returns an ObjectProperty for this model object attribute.