com.adobe.idp.dsc.registry.infomodel
Interface CompositeEditorAttribute

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CompositeEditorObject, CompositeEditorSimpleAttribute

public interface CompositeEditorAttribute
extends java.io.Serializable

A CompositeEditorAttribute is an attribute contained in a composite editor. A composite editor component contains one or more attributes, each of which maps to an underlying property of the composite editor's composite type.

Method Summary

java.lang.String	getDefaultValue() Returns the default value associated with this parameter.
java.lang.String[]	getFilterCategories() Returns an array containing filter categories associated with this parameter.
java.lang.String	getHint() Retrieves a brief amount of text that describes the purpose of a composite attribute and is displayed within related user interfaces.
java.lang.String	getName() Retrieves the name of the attribute.
java.lang.String	getProperty() Retrieves the property of an attribute that is used to explicitly specify a property name of the related composite type class, where the property name is different than the attribute name.
java.lang.String[]	getSupportedExpressionTypes() Retrieves an array of supported expression types.
java.lang.String	getTitle() Retrieves the title of an attribute that is expected to show up in the related tooling.
java.lang.String	getType() Retrieves the attribute type's class name.
boolean	isRequired() determines whether this parameter is required.

Method Detail

getName

java.lang.String getName()

Retrieves the name of the attribute. If the property is not explicity defined, it is assumed that the name is equal to the property name used to set and retrieve the values from the composite type.

Returns:

The name of the attribute.

getTitle

java.lang.String getTitle()

Retrieves the title of an attribute that is expected to show up in the related tooling.

Returns:

The title of an attribute that is expected to show up in the related tooling.

getProperty

java.lang.String getProperty()

Retrieves the property of an attribute that is used to explicitly specify a property name of the related composite type class, where the property name is different than the attribute name.

Returns:

The attribute property.

getType

java.lang.String getType()

Retrieves the attribute type's class name.

Returns:

The attribute type's class name.

getHint

java.lang.String getHint()

Retrieves a brief amount of text that describes the purpose of a composite attribute and is displayed within related user interfaces.

Returns:

A brief amount of text that describes the purpose of a composite attribute.

getSupportedExpressionTypes

java.lang.String[] getSupportedExpressionTypes()

Retrieves an array of supported expression types. The array is used to filter the expression types that appear in the IDE when binding to a parameter. If this value is empty, it is assumed that all expression types are supported.

Returns:

An array of supported expression types.

getFilterCategories

java.lang.String[] getFilterCategories()

Returns an array containing filter categories associated with this parameter. It is used to show the parameter when the appropriate filter toggle is used in the IDE. If the returned value is NULL, it is assumed that all filter categories are supported.

Returns:

An array of associated filter categories.

getDefaultValue

java.lang.String getDefaultValue()

Returns the default value associated with this parameter. It is used as default value in the property editor associated with the parameter in the IDE.

Returns:

String representation of the default value.

isRequired

boolean isRequired()

determines whether this parameter is required.

Returns: