org.openmdx.ui1.cci2
Interface Segment

All Superinterfaces:

org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.Segment, org.openmdx.compatibility.view1.cci2.ViewCapable

All Known Subinterfaces:

Segment

public interface Segment
extends org.openmdx.base.cci2.Segment

Class Segment

Nested Class Summary

Nested classes/interfaces inherited from interface org.openmdx.base.cci2.Segment

org.openmdx.base.cci2.Segment.Identity

Method Summary

void	addElement(boolean idIsPersistent, String id, Element element) Adds the specified element to the set of the values for the reference element.
void	addElementDefinition(boolean nameIsPersistent, String name, ElementDefinition elementDefinition) Adds the specified element to the set of the values for the reference elementDefinition.
void	addFeatureDefinition(boolean qualifiedNameIsPersistent, String qualifiedName, FeatureDefinition featureDefinition) Adds the specified element to the set of the values for the reference featureDefinition.
org.openmdx.base.cci2.Void	assertInspector(String forClass)
SegmentExportElementsResult	exportElements(boolean includeAutoGenerated)
<T extends AssertableInspector> Collection<T>	getAssertableInspector() Retrieves a set containing all the elements for the reference assertableInspector.
AssertableInspector	getAssertableInspector(boolean nameIsPersistent, String name) Retrieves the value for the reference assertableInspector for the specified qualifier attribute value.
<T extends Element> Collection<T>	getElement() Retrieves a set containing all the elements for the reference element.
Element	getElement(boolean idIsPersistent, String id) Retrieves the value for the reference element for the specified qualifier attribute value.
<T extends ElementDefinition> Collection<T>	getElementDefinition() Retrieves a set containing all the elements for the reference elementDefinition.
ElementDefinition	getElementDefinition(boolean nameIsPersistent, String name) Retrieves the value for the reference elementDefinition for the specified qualifier attribute value.
<T extends FeatureDefinition> Collection<T>	getFeatureDefinition() Retrieves a set containing all the elements for the reference featureDefinition.
FeatureDefinition	getFeatureDefinition(boolean qualifiedNameIsPersistent, String qualifiedName) Retrieves the value for the reference featureDefinition for the specified qualifier attribute value.

Methods inherited from interface org.openmdx.base.cci2.Segment

getDescription, getProvider, setDescription

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

getView, getView

Method Detail

assertInspector

org.openmdx.base.cci2.Void assertInspector(String forClass)

getAssertableInspector

<T extends AssertableInspector> Collection<T> getAssertableInspector()

Retrieves a set containing all the elements for the reference assertableInspector.

Returns:

A set containing all the elements for this reference.

getAssertableInspector

AssertableInspector getAssertableInspector(boolean nameIsPersistent,
                                           String name)

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

Parameters:

nameIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getElement

<T extends Element> Collection<T> getElement()

Retrieves a set containing all the elements for the reference element.

Returns:

A set containing all the elements for this reference.

getElement

Element getElement(boolean idIsPersistent,
                   String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

addElement

void addElement(boolean idIsPersistent,
                String id,
                Element element)

Adds the specified element to the set of the values for the reference element.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

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

element - The element to be appended.

getElementDefinition

<T extends ElementDefinition> Collection<T> getElementDefinition()

Retrieves a set containing all the elements for the reference elementDefinition.

Returns:

A set containing all the elements for this reference.

getElementDefinition

ElementDefinition getElementDefinition(boolean nameIsPersistent,
                                       String name)

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

Parameters:

nameIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

addElementDefinition

void addElementDefinition(boolean nameIsPersistent,
                          String name,
                          ElementDefinition elementDefinition)

Adds the specified element to the set of the values for the reference elementDefinition.

Note: This is an extension to the JMI 1 standard.

Parameters:

nameIsPersistent - true if name is persistent

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

elementDefinition - The element to be appended.

exportElements

SegmentExportElementsResult exportElements(boolean includeAutoGenerated)

getFeatureDefinition

<T extends FeatureDefinition> Collection<T> getFeatureDefinition()

Retrieves a set containing all the elements for the reference featureDefinition.

Returns:

A set containing all the elements for this reference.

getFeatureDefinition

FeatureDefinition getFeatureDefinition(boolean qualifiedNameIsPersistent,
                                       String qualifiedName)

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

Parameters:

qualifiedNameIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

addFeatureDefinition

void addFeatureDefinition(boolean qualifiedNameIsPersistent,
                          String qualifiedName,
                          FeatureDefinition featureDefinition)

Adds the specified element to the set of the values for the reference featureDefinition.

Note: This is an extension to the JMI 1 standard.

Parameters:

qualifiedNameIsPersistent - true if qualifiedName is persistent

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

featureDefinition - The element to be appended.