org.openmdx.ui1.cci
Interface ElementDefinition

All Superinterfaces:

AbstractElementDefinition, BasicObject, ContextCapable, ExtentCapable, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, org.openmdx.base.accessor.jmi.cci.RefObject_1_0, ViewCapable

All Known Implementing Classes:

ElementDefinitionImpl

public interface ElementDefinition
extends BasicObject, AbstractElementDefinition

Method Summary

void	addAdditionalElementDefinition(AdditionalElementDefinition newValue)
void	addAdditionalElementDefinition(String id, AdditionalElementDefinition newValue)
void	addAlternateElementDefinition(AlternateElementDefinition newValue)
void	addAlternateElementDefinition(String id, AlternateElementDefinition newValue)
Collection	getAdditionalElementDefinition() Retrieves a collection containing all the elements for the reference additionalElementDefinition.
List	getAdditionalElementDefinition(AdditionalElementDefinitionFilter filter) Retrieves the value for the reference additionalElementDefinition for the specified filter.
List	getAdditionalElementDefinition(AdditionalElementDefinitionQuery query) Retrieves the value for the reference additionalElementDefinition for the specified query.
AdditionalElementDefinition	getAdditionalElementDefinition(String id) Retrieves the value for the reference additionalElementDefinition for the specified qualifier attribute value.
Collection	getAlternateElementDefinition() Retrieves a collection containing all the elements for the reference alternateElementDefinition.
List	getAlternateElementDefinition(AlternateElementDefinitionFilter filter) Retrieves the value for the reference alternateElementDefinition for the specified filter.
List	getAlternateElementDefinition(AlternateElementDefinitionQuery query) Retrieves the value for the reference alternateElementDefinition for the specified query.
AlternateElementDefinition	getAlternateElementDefinition(String id) Retrieves the value for the reference alternateElementDefinition for the specified qualifier attribute value.
boolean	isActive() Retrieves the value for the attribute active.
void	removeAdditionalElementDefinition(String id)
void	removeAlternateElementDefinition(String id)
void	setActive(boolean newValue) Sets a new value for the attribute active.

Methods inherited from interface org.openmdx.base.cci.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

Methods inherited from interface org.openmdx.base.cci.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, getView

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Methods inherited from interface org.openmdx.ui1.cci.AbstractElementDefinition

getBackColor, getColor, getDataBindingName, getDecimalPlaces, getDisplayValueExpr, getDisplayValueExpr, getEventHandler, getEventHandler, getIconKey, getIncrement, getLabel, getLabel, getMaxLength, getMaxMember, getMaxValue, getMemberDefaultValue, getMemberDefaultValue, getMemberElementName, getMemberElementName, getMemberMimeType, getMemberMimeType, getMinValue, getMultiplicity, getOrder, getOrder, getOrderFieldGroup, getOrderFieldGroup, getOrderObjectContainer, getOrderObjectContainer, getShortLabel, getShortLabel, getShowMaxMember, getSizeXWeight, getSkipRow, getSpanRow, getTitleIndex, getToolTip, getToolTip, isChangeable, isColumnBreak, isFilterable, isHasThousandsSeparator, isInPlace, isPassword, isSortable, setBackColor, setChangeable, setColor, setColumnBreak, setDataBindingName, setDecimalPlaces, setDisplayValueExpr, setDisplayValueExpr, setEventHandler, setEventHandler, setFilterable, setHasThousandsSeparator, setIconKey, setIncrement, setInPlace, setLabel, setLabel, setMaxLength, setMaxMember, setMaxValue, setMemberDefaultValue, setMemberDefaultValue, setMemberElementName, setMemberElementName, setMemberMimeType, setMemberMimeType, setMinValue, setMultiplicity, setOrder, setOrder, setOrderFieldGroup, setOrderFieldGroup, setOrderObjectContainer, setOrderObjectContainer, setPassword, setShortLabel, setShortLabel, setShowMaxMember, setSizeXWeight, setSkipRow, setSortable, setSpanRow, setTitleIndex, setToolTip, setToolTip

Method Detail

isActive

boolean isActive()

Retrieves the value for the attribute active.

Returns:

The non-null value for attribute active.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setActive

void setActive(boolean newValue)

Sets a new value for the attribute active.

Parameters:

newValue - The non-null new value for attribute active.

Throws:

JmiException - If the value cannot be set for some reason.

getAdditionalElementDefinition

AdditionalElementDefinition getAdditionalElementDefinition(String id)

Retrieves the value for the reference additionalElementDefinition for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAdditionalElementDefinition

Collection getAdditionalElementDefinition()

Retrieves a collection containing all the elements for the reference additionalElementDefinition.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAdditionalElementDefinition

List getAdditionalElementDefinition(AdditionalElementDefinitionFilter filter)

Retrieves the value for the reference additionalElementDefinition for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAdditionalElementDefinition

List getAdditionalElementDefinition(AdditionalElementDefinitionQuery query)

Retrieves the value for the reference additionalElementDefinition for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addAdditionalElementDefinition

void addAdditionalElementDefinition(String id,
                                    AdditionalElementDefinition newValue)

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addAdditionalElementDefinition

void addAdditionalElementDefinition(AdditionalElementDefinition newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeAdditionalElementDefinition

void removeAdditionalElementDefinition(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getAlternateElementDefinition

AlternateElementDefinition getAlternateElementDefinition(String id)

Retrieves the value for the reference alternateElementDefinition for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAlternateElementDefinition

Collection getAlternateElementDefinition()

Retrieves a collection containing all the elements for the reference alternateElementDefinition.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAlternateElementDefinition

List getAlternateElementDefinition(AlternateElementDefinitionFilter filter)

Retrieves the value for the reference alternateElementDefinition for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAlternateElementDefinition

List getAlternateElementDefinition(AlternateElementDefinitionQuery query)

Retrieves the value for the reference alternateElementDefinition for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addAlternateElementDefinition

void addAlternateElementDefinition(String id,
                                   AlternateElementDefinition newValue)

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addAlternateElementDefinition

void addAlternateElementDefinition(AlternateElementDefinition newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeAlternateElementDefinition

void removeAlternateElementDefinition(String id)

Throws:

JmiException - If the value cannot be removed for some reason.