org.openmdx.ui1.cci2
Interface AbstractElementDefinition

All Known Subinterfaces:

AbstractElementDefinition, AdditionalElementDefinition, AdditionalElementDefinition, AlternateElementDefinition, AlternateElementDefinition, ElementDefinition, ElementDefinition

All Known Implementing Classes:

AdditionalElementDefinition, AlternateElementDefinition, ElementDefinition

public interface AbstractElementDefinition

Abstract class AbstractElementDefinition

Method Summary

String	getBackColor() Retrieves the possibly null value for the optional attribute backColor.
String	getColor() Retrieves the possibly null value for the optional attribute color.
String	getDataBindingName() Retrieves the possibly null value for the optional attribute dataBindingName.
Integer	getDecimalPlaces() Retrieves the possibly null value for the optional attribute decimalPlaces.
List<String>	getDisplayValueExpr() Retrieves a list containing all the elements for the attribute displayValueExpr.
List<String>	getEventHandler() Retrieves a list containing all the elements for the attribute eventHandler.
String	getIconKey() Retrieves the possibly null value for the optional attribute iconKey.
BigDecimal	getIncrement() Retrieves the possibly null value for the optional attribute increment.
List<String>	getLabel() Retrieves a list containing all the elements for the attribute label.
Integer	getMaxLength() Retrieves the possibly null value for the optional attribute maxLength.
Integer	getMaxMember() Retrieves the possibly null value for the optional attribute maxMember.
String	getMaxValue() Retrieves the possibly null value for the optional attribute maxValue.
List<String>	getMemberDefaultValue() Retrieves a list containing all the elements for the attribute memberDefaultValue.
List<String>	getMemberElementName() Retrieves a list containing all the elements for the attribute memberElementName.
List<String>	getMemberMimeType() Retrieves a list containing all the elements for the attribute memberMimeType.
String	getMinValue() Retrieves the possibly null value for the optional attribute minValue.
String	getMultiplicity() Retrieves the possibly null value for the optional attribute multiplicity.
List<Integer>	getOrder() Retrieves a list containing all the elements for the attribute order.
List<Integer>	getOrderFieldGroup() Retrieves a list containing all the elements for the attribute orderFieldGroup.
List<Integer>	getOrderObjectContainer() Retrieves a list containing all the elements for the attribute orderObjectContainer.
List<String>	getShortLabel() Retrieves a list containing all the elements for the attribute shortLabel.
Integer	getShowMaxMember() Retrieves the possibly null value for the optional attribute showMaxMember.
Integer	getSizeXweight() Retrieves the possibly null value for the optional attribute sizeXWeight.
Integer	getSkipRow() Retrieves the possibly null value for the optional attribute skipRow.
Integer	getSpanRow() Retrieves the possibly null value for the optional attribute spanRow.
Integer	getTitleIndex() Retrieves the possibly null value for the optional attribute titleIndex.
List<String>	getToolTip() Retrieves a list containing all the elements for the attribute toolTip.
Boolean	isChangeable() Retrieves the possibly null value for the optional attribute changeable.
Boolean	isColumnBreak() Retrieves the possibly null value for the optional attribute columnBreak.
Boolean	isFilterable() Retrieves the possibly null value for the optional attribute filterable.
Boolean	isHasThousandsSeparator() Retrieves the possibly null value for the optional attribute hasThousandsSeparator.
Boolean	isInPlace() Retrieves the possibly null value for the optional attribute inPlace.
Boolean	isPassword() Retrieves the possibly null value for the optional attribute isPassword.
Boolean	isSortable() Retrieves the possibly null value for the optional attribute sortable.
void	setBackColor(String backColor) Sets a new value for the attribute backColor.
void	setChangeable(Boolean changeable) Sets a new value for the attribute changeable.
void	setColor(String color) Sets a new value for the attribute color.
void	setColumnBreak(Boolean columnBreak) Sets a new value for the attribute columnBreak.
void	setDataBindingName(String dataBindingName) Sets a new value for the attribute dataBindingName.
void	setDecimalPlaces(Integer decimalPlaces) Sets a new value for the attribute decimalPlaces.
void	setDisplayValueExpr(String... displayValueExpr) Clears displayValueExpr and adds the given value(s).
void	setEventHandler(String... eventHandler) Clears eventHandler and adds the given value(s).
void	setFilterable(Boolean filterable) Sets a new value for the attribute filterable.
void	setHasThousandsSeparator(Boolean hasThousandsSeparator) Sets a new value for the attribute hasThousandsSeparator.
void	setIconKey(String iconKey) Sets a new value for the attribute iconKey.
void	setIncrement(BigDecimal increment) Sets a new value for the attribute increment.
void	setInPlace(Boolean inPlace) Sets a new value for the attribute inPlace.
void	setLabel(String... label) Clears label and adds the given value(s).
void	setMaxLength(Integer maxLength) Sets a new value for the attribute maxLength.
void	setMaxMember(Integer maxMember) Sets a new value for the attribute maxMember.
void	setMaxValue(String maxValue) Sets a new value for the attribute maxValue.
void	setMemberDefaultValue(String... memberDefaultValue) Clears memberDefaultValue and adds the given value(s).
void	setMemberElementName(String... memberElementName) Clears memberElementName and adds the given value(s).
void	setMemberMimeType(String... memberMimeType) Clears memberMimeType and adds the given value(s).
void	setMinValue(String minValue) Sets a new value for the attribute minValue.
void	setMultiplicity(String multiplicity) Sets a new value for the attribute multiplicity.
void	setOrder(int... order) Clears order and adds the given value(s).
void	setOrderFieldGroup(int... orderFieldGroup) Clears orderFieldGroup and adds the given value(s).
void	setOrderObjectContainer(int... orderObjectContainer) Clears orderObjectContainer and adds the given value(s).
void	setPassword(Boolean isPassword) Sets a new value for the attribute isPassword.
void	setShortLabel(String... shortLabel) Clears shortLabel and adds the given value(s).
void	setShowMaxMember(Integer showMaxMember) Sets a new value for the attribute showMaxMember.
void	setSizeXweight(Integer sizeXweight) Sets a new value for the attribute sizeXWeight.
void	setSkipRow(Integer skipRow) Sets a new value for the attribute skipRow.
void	setSortable(Boolean sortable) Sets a new value for the attribute sortable.
void	setSpanRow(Integer spanRow) Sets a new value for the attribute spanRow.
void	setTitleIndex(Integer titleIndex) Sets a new value for the attribute titleIndex.
void	setToolTip(String... toolTip) Clears toolTip and adds the given value(s).

Method Detail

getBackColor

String getBackColor()

Retrieves the possibly null value for the optional attribute backColor.

Returns:

The possibly null value for attribute backColor.

setBackColor

void setBackColor(String backColor)

Sets a new value for the attribute backColor.

Parameters:

backColor - The possibly null new value for attribute backColor.

isChangeable

Boolean isChangeable()

Retrieves the possibly null value for the optional attribute changeable.

Returns:

The possibly null value for attribute changeable.

setChangeable

void setChangeable(Boolean changeable)

Sets a new value for the attribute changeable.

Parameters:

changeable - The possibly null new value for attribute changeable.

getColor

String getColor()

Retrieves the possibly null value for the optional attribute color.

Returns:

The possibly null value for attribute color.

setColor

void setColor(String color)

Sets a new value for the attribute color.

Parameters:

color - The possibly null new value for attribute color.

isColumnBreak

Boolean isColumnBreak()

Retrieves the possibly null value for the optional attribute columnBreak.

Returns:

The possibly null value for attribute columnBreak.

setColumnBreak

void setColumnBreak(Boolean columnBreak)

Sets a new value for the attribute columnBreak.

Parameters:

columnBreak - The possibly null new value for attribute columnBreak.

getDataBindingName

String getDataBindingName()

Retrieves the possibly null value for the optional attribute dataBindingName.

Returns:

The possibly null value for attribute dataBindingName.

setDataBindingName

void setDataBindingName(String dataBindingName)

Sets a new value for the attribute dataBindingName.

Parameters:

dataBindingName - The possibly null new value for attribute dataBindingName.

getDecimalPlaces

Integer getDecimalPlaces()

Retrieves the possibly null value for the optional attribute decimalPlaces.

Returns:

The possibly null value for attribute decimalPlaces.

setDecimalPlaces

void setDecimalPlaces(Integer decimalPlaces)

Sets a new value for the attribute decimalPlaces.

Parameters:

decimalPlaces - The possibly null new value for attribute decimalPlaces.

getDisplayValueExpr

List<String> getDisplayValueExpr()

Retrieves a list containing all the elements for the attribute displayValueExpr.

Returns:

A list containing all elements for this attribute.

setDisplayValueExpr

void setDisplayValueExpr(String... displayValueExpr)

Clears displayValueExpr and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Parameters:

displayValueExpr - value(s) to be added to displayValueExpr

getEventHandler

List<String> getEventHandler()

Retrieves a list containing all the elements for the attribute eventHandler.

Returns:

A list containing all elements for this attribute.

setEventHandler

void setEventHandler(String... eventHandler)

Clears eventHandler and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Parameters:

eventHandler - value(s) to be added to eventHandler

isFilterable

Boolean isFilterable()

Retrieves the possibly null value for the optional attribute filterable.

Returns:

The possibly null value for attribute filterable.

setFilterable

void setFilterable(Boolean filterable)

Sets a new value for the attribute filterable.

Parameters:

filterable - The possibly null new value for attribute filterable.

isHasThousandsSeparator

Boolean isHasThousandsSeparator()

Retrieves the possibly null value for the optional attribute hasThousandsSeparator.

Returns:

The possibly null value for attribute hasThousandsSeparator.

setHasThousandsSeparator

void setHasThousandsSeparator(Boolean hasThousandsSeparator)

Sets a new value for the attribute hasThousandsSeparator.

Parameters:

hasThousandsSeparator - The possibly null new value for attribute hasThousandsSeparator.

getIconKey

String getIconKey()

Retrieves the possibly null value for the optional attribute iconKey.

Returns:

The possibly null value for attribute iconKey.

setIconKey

void setIconKey(String iconKey)

Sets a new value for the attribute iconKey.

Parameters:

iconKey - The possibly null new value for attribute iconKey.

isInPlace

Boolean isInPlace()

Retrieves the possibly null value for the optional attribute inPlace.

Returns:

The possibly null value for attribute inPlace.

setInPlace

void setInPlace(Boolean inPlace)

Sets a new value for the attribute inPlace.

Parameters:

inPlace - The possibly null new value for attribute inPlace.

getIncrement

BigDecimal getIncrement()

Retrieves the possibly null value for the optional attribute increment.

Returns:

The possibly null value for attribute increment.

setIncrement

void setIncrement(BigDecimal increment)

Sets a new value for the attribute increment.

Parameters:

increment - The possibly null new value for attribute increment.

isPassword

Boolean isPassword()

Retrieves the possibly null value for the optional attribute isPassword.

Returns:

The possibly null value for attribute isPassword.

setPassword

void setPassword(Boolean isPassword)

Sets a new value for the attribute isPassword.

Parameters:

isPassword - The possibly null new value for attribute isPassword.

getLabel

List<String> getLabel()

Retrieves a list containing all the elements for the attribute label.

Returns:

A list containing all elements for this attribute.

setLabel

void setLabel(String... label)

Clears label and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Parameters:

label - value(s) to be added to label

getMaxLength

Integer getMaxLength()

Retrieves the possibly null value for the optional attribute maxLength.

Returns:

The possibly null value for attribute maxLength.

setMaxLength

void setMaxLength(Integer maxLength)

Sets a new value for the attribute maxLength.

Parameters:

maxLength - The possibly null new value for attribute maxLength.

getMaxMember

Integer getMaxMember()

Retrieves the possibly null value for the optional attribute maxMember.

Returns:

The possibly null value for attribute maxMember.

setMaxMember

void setMaxMember(Integer maxMember)

Sets a new value for the attribute maxMember.

Parameters:

maxMember - The possibly null new value for attribute maxMember.

getMaxValue

String getMaxValue()

Retrieves the possibly null value for the optional attribute maxValue.

Returns:

The possibly null value for attribute maxValue.

setMaxValue

void setMaxValue(String maxValue)

Sets a new value for the attribute maxValue.

Parameters:

maxValue - The possibly null new value for attribute maxValue.

getMemberDefaultValue

List<String> getMemberDefaultValue()

Retrieves a list containing all the elements for the attribute memberDefaultValue.

Returns:

A list containing all elements for this attribute.

setMemberDefaultValue

void setMemberDefaultValue(String... memberDefaultValue)

Clears memberDefaultValue and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Parameters:

memberDefaultValue - value(s) to be added to memberDefaultValue

getMemberElementName

List<String> getMemberElementName()

Retrieves a list containing all the elements for the attribute memberElementName.

Returns:

A list containing all elements for this attribute.

setMemberElementName

void setMemberElementName(String... memberElementName)

Clears memberElementName and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Parameters:

memberElementName - value(s) to be added to memberElementName

getMemberMimeType

List<String> getMemberMimeType()

Retrieves a list containing all the elements for the attribute memberMimeType.

Returns:

A list containing all elements for this attribute.

setMemberMimeType

void setMemberMimeType(String... memberMimeType)

Clears memberMimeType and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Parameters:

memberMimeType - value(s) to be added to memberMimeType

getMinValue

String getMinValue()

Retrieves the possibly null value for the optional attribute minValue.

Returns:

The possibly null value for attribute minValue.

setMinValue

void setMinValue(String minValue)

Sets a new value for the attribute minValue.

Parameters:

minValue - The possibly null new value for attribute minValue.

getMultiplicity

String getMultiplicity()

Retrieves the possibly null value for the optional attribute multiplicity.

Returns:

The possibly null value for attribute multiplicity.

setMultiplicity

void setMultiplicity(String multiplicity)

Sets a new value for the attribute multiplicity.

Parameters:

multiplicity - The possibly null new value for attribute multiplicity.

getOrder

List<Integer> getOrder()

Retrieves a list containing all the elements for the attribute order.

Returns:

A list containing all elements for this attribute.

setOrder

void setOrder(int... order)

Clears order and adds the given value(s).

This method is equivalent to

   list.clear();
   for(int e : attributeName){
     list.add(e);
   }
 

Parameters:

order - value(s) to be added to order

getOrderFieldGroup

List<Integer> getOrderFieldGroup()

Retrieves a list containing all the elements for the attribute orderFieldGroup.

Returns:

A list containing all elements for this attribute.

setOrderFieldGroup

void setOrderFieldGroup(int... orderFieldGroup)

Clears orderFieldGroup and adds the given value(s).

This method is equivalent to

   list.clear();
   for(int e : attributeName){
     list.add(e);
   }
 

Parameters:

orderFieldGroup - value(s) to be added to orderFieldGroup

getOrderObjectContainer

List<Integer> getOrderObjectContainer()

Retrieves a list containing all the elements for the attribute orderObjectContainer.

Returns:

A list containing all elements for this attribute.

setOrderObjectContainer

void setOrderObjectContainer(int... orderObjectContainer)

Clears orderObjectContainer and adds the given value(s).

This method is equivalent to

   list.clear();
   for(int e : attributeName){
     list.add(e);
   }
 

Parameters:

orderObjectContainer - value(s) to be added to orderObjectContainer

getShortLabel

List<String> getShortLabel()

Retrieves a list containing all the elements for the attribute shortLabel.

Returns:

A list containing all elements for this attribute.

setShortLabel

void setShortLabel(String... shortLabel)

Clears shortLabel and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Parameters:

shortLabel - value(s) to be added to shortLabel

getShowMaxMember

Integer getShowMaxMember()

Retrieves the possibly null value for the optional attribute showMaxMember.

Returns:

The possibly null value for attribute showMaxMember.

setShowMaxMember

void setShowMaxMember(Integer showMaxMember)

Sets a new value for the attribute showMaxMember.

Parameters:

showMaxMember - The possibly null new value for attribute showMaxMember.

getSizeXweight

Integer getSizeXweight()

Retrieves the possibly null value for the optional attribute sizeXWeight.

Returns:

The possibly null value for attribute sizeXWeight.

setSizeXweight

void setSizeXweight(Integer sizeXweight)

Sets a new value for the attribute sizeXWeight.

Parameters:

sizeXweight - The possibly null new value for attribute sizeXWeight.

getSkipRow

Integer getSkipRow()

Retrieves the possibly null value for the optional attribute skipRow.

Returns:

The possibly null value for attribute skipRow.

setSkipRow

void setSkipRow(Integer skipRow)

Sets a new value for the attribute skipRow.

Parameters:

skipRow - The possibly null new value for attribute skipRow.

isSortable

Boolean isSortable()

Retrieves the possibly null value for the optional attribute sortable.

Returns:

The possibly null value for attribute sortable.

setSortable

void setSortable(Boolean sortable)

Sets a new value for the attribute sortable.

Parameters:

sortable - The possibly null new value for attribute sortable.

getSpanRow

Integer getSpanRow()

Retrieves the possibly null value for the optional attribute spanRow.

Returns:

The possibly null value for attribute spanRow.

setSpanRow

void setSpanRow(Integer spanRow)

Sets a new value for the attribute spanRow.

Parameters:

spanRow - The possibly null new value for attribute spanRow.

getTitleIndex

Integer getTitleIndex()

Retrieves the possibly null value for the optional attribute titleIndex.

Returns:

The possibly null value for attribute titleIndex.

setTitleIndex

void setTitleIndex(Integer titleIndex)

Sets a new value for the attribute titleIndex.

Parameters:

titleIndex - The possibly null new value for attribute titleIndex.

getToolTip

List<String> getToolTip()

Retrieves a list containing all the elements for the attribute toolTip.

Returns:

A list containing all elements for this attribute.

setToolTip

void setToolTip(String... toolTip)

Clears toolTip and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Parameters:

toolTip - value(s) to be added to toolTip