Package com.adobe.aem.dermis.model

Interface IProperty

All Superinterfaces:

IAsset, ITypeAsset, java.io.Serializable

All Known Subinterfaces:

IOperationArgument

All Known Implementing Classes:

Property, RestProperty, WSProperty

@ProviderType
public interface IProperty
extends ITypeAsset

Represents a property and it's metadata description. Property reside within a DataModel and can be used as keys for relationships between DataModel.

Method Summary

Modifier and Type	Method	Description
IDataModel	getAssociatedDataModel()	Returns the data model associated with this property either One-To-One or One-To-Many
IDataModel	getChildDataModel()	Gets the associated data model.
IDataModel	getDataModel()	Gets the datamodel for which this property belong
java.lang.Object[]	getEnumList()	Gets the enum related of this property.
java.lang.String	getIdentifier()	Gets the identifier of this property.
java.lang.String	getParameterType()	Gets the parameter type of this property.
java.util.List<? extends IProperty>	getProperties()	Gets the properties of this property if property type is Array.
java.lang.String	getReferenceName()	Returns the reference entity name.
java.lang.Boolean	getRequired()	Determines whether or not this property accepts null values.
IRule	getRules()	Returns the rules of the attribute.
boolean	isBelowCollection()	Return true if property is part of collection entity.
boolean	isComplexType()	Returns true if attribute is of type ARRAY or OBJECT.
boolean	isComputed()	Determines if this property is a computed property.
java.lang.Boolean	isMetadataKey()	Determines if this property is the metadata key(s) of its datamodel.
boolean	isNullable()	Determines whether or not this property accepts null values.
java.lang.Boolean	isPrimaryKey()	Determines if this property is (one of) the primary key(s) of its datamodel.
boolean	isPrimitiveType()	Returns true if attribute is of primitive type.
void	setChildDataModel(IDataModel childDataModel)	Sets the associated data model.

Methods inherited from interface com.adobe.aem.dermis.model.IAsset

getDescription, getId, getName, getTitle

Methods inherited from interface com.adobe.aem.dermis.model.ITypeAsset

getFormatType, getMediaBinaryEncoding, getMediaType, getSubType, getSubTypeRef, getType, getTypeRef, setFormatType, setSubType, setType

Method Detail

getParameterType

java.lang.String getParameterType()

Gets the parameter type of this property.

Returns:

the parameter type of this property.

getDataModel

IDataModel getDataModel()

Gets the datamodel for which this property belong

Returns:

this property's datamodel.

getRequired

java.lang.Boolean getRequired()

Determines whether or not this property accepts null values.

Returns:

true if this property except values, false if not and null if not known.

isNullable

boolean isNullable()

Determines whether or not this property accepts null values.

Returns:

true if this property accept null values, false if not.

isComputed

boolean isComputed()

Determines if this property is a computed property.

Returns:

true if this property is a computed property, or false if not

isPrimaryKey

java.lang.Boolean isPrimaryKey()

Determines if this property is (one of) the primary key(s) of its datamodel.

Returns:

true if this property is a primary key, or false if not (or if this is not determinable).

getChildDataModel

IDataModel getChildDataModel()

Gets the associated data model.

Returns:

the associated dataModel.

getAssociatedDataModel

IDataModel getAssociatedDataModel()

Returns the data model associated with this property either One-To-One or One-To-Many

Returns:

setChildDataModel

void setChildDataModel(IDataModel childDataModel)

Sets the associated data model.

Parameters:

childDataModel - the associated dataModel.

getEnumList

java.lang.Object[] getEnumList()

Gets the enum related of this property.

Returns:

the enum related of this property.

getProperties

java.util.List<? extends IProperty> getProperties()

Gets the properties of this property if property type is Array.

Returns:

the list of properties.

getIdentifier

java.lang.String getIdentifier()

Gets the identifier of this property.

Returns:

the identifier of this property.

getReferenceName

java.lang.String getReferenceName()

Returns the reference entity name.

Returns:

Returns the reference entity name.

isComplexType

boolean isComplexType()

Returns true if attribute is of type ARRAY or OBJECT.

Returns:

- Returns true if attribute is of type ARRAY or OBJECT.

isPrimitiveType

boolean isPrimitiveType()

Returns true if attribute is of primitive type.

Returns:

- Returns true if attribute is of primitive type.

getRules

IRule getRules()

Returns the rules of the attribute.

Returns:

- Returns the rules of the attribute.

isBelowCollection

boolean isBelowCollection()

Return true if property is part of collection entity. This property is available only if property is retrieved via IFormDataModelManager.getEntityPropertyByPath(String, String)

Returns:

- true, if property is part of collection entity.

isMetadataKey

java.lang.Boolean isMetadataKey()

Determines if this property is the metadata key(s) of its datamodel. Metadata specifies, that the particular property will be saved as metadata apart from original data i.e user can query on the basis of properties with metadata enabled.

Returns:

true if this property is a metadata key, or false if not (or if this is not determinable).