org.openmdx.ui1.jmi1
Interface Segment

All Superinterfaces:

org.openmdx.base.cci2.ContextCapable, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, org.openmdx.base.cci2.Segment, org.openmdx.compatibility.view1.cci2.ViewCapable

public interface Segment
extends Segment, org.openmdx.base.jmi1.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(Element newValue)
void	addElement(String id, Element newValue)
void	addElementDefinition(ElementDefinition newValue)
void	addElementDefinition(String name, ElementDefinition newValue)
void	addFeatureDefinition(FeatureDefinition newValue)
void	addFeatureDefinition(String qualifiedName, FeatureDefinition newValue)
<T extends org.openmdx.base.cci2.Void> T	assertInspector(SegmentAssertInspectorParams params)
<T extends SegmentExportElementsResult> T	exportElements(SegmentExportElementsParams params)
<T extends AssertableInspector> List<T>	getAssertableInspector(AssertableInspectorQuery query) Retrieves the value for the reference assertableInspector for the specified query.
<T extends Element> List<T>	getElement(ElementQuery query) Retrieves the value for the reference element for the specified query.
<T extends ElementDefinition> List<T>	getElementDefinition(ElementDefinitionQuery query) Retrieves the value for the reference elementDefinition for the specified query.
<T extends org.openmdx.base.cci2.ExtentCapable> List<T>	getExtent(org.openmdx.base.cci2.ExtentCapableQuery query) Retrieves the value for the reference extent for the specified query.
<T extends FeatureDefinition> List<T>	getFeatureDefinition(FeatureDefinitionQuery query) Retrieves the value for the reference featureDefinition for the specified query.
org.openmdx.base.jdo2.Provider	getProvider() Retrieves the value for the reference provider.
<T extends org.openmdx.compatibility.view1.cci2.View> List<T>	getView(org.openmdx.compatibility.view1.cci2.ViewQuery query) Retrieves the value for the reference view for the specified query.
void	removeElement(String id)
void	removeElementDefinition(String name)
void	removeFeatureDefinition(String qualifiedName)

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

assertInspector, exportElements, getAssertableInspector, getElement, getElementDefinition, getFeatureDefinition

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

setProvider, setProvider

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

getDescription, setDescription

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

getView

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

Method Detail

getExtent

<T extends org.openmdx.base.cci2.ExtentCapable> List<T> getExtent(org.openmdx.base.cci2.ExtentCapableQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getProvider

org.openmdx.base.jdo2.Provider getProvider()

Retrieves the value for the reference provider.

Specified by:

getProvider in interface org.openmdx.base.cci2.Segment

Returns:

The non-null value for this reference.

getView

<T extends org.openmdx.compatibility.view1.cci2.View> List<T> getView(org.openmdx.compatibility.view1.cci2.ViewQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

assertInspector

<T extends org.openmdx.base.cci2.Void> T assertInspector(SegmentAssertInspectorParams params)
                                                     throws javax.jmi.reflect.RefException

Throws:

javax.jmi.reflect.RefException

getAssertableInspector

<T extends AssertableInspector> List<T> getAssertableInspector(AssertableInspectorQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getElement

<T extends Element> List<T> getElement(ElementQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addElement

void addElement(String id,
                Element newValue)

Parameters:

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

newValue - The element to be appended.

addElement

void addElement(Element newValue)

Parameters:

newValue - The element to be appended.

removeElement

void removeElement(String id)

getElementDefinition

<T extends ElementDefinition> List<T> getElementDefinition(ElementDefinitionQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addElementDefinition

void addElementDefinition(String name,
                          ElementDefinition newValue)

Parameters:

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

newValue - The element to be appended.

addElementDefinition

void addElementDefinition(ElementDefinition newValue)

Parameters:

newValue - The element to be appended.

removeElementDefinition

void removeElementDefinition(String name)

exportElements

<T extends SegmentExportElementsResult> T exportElements(SegmentExportElementsParams params)
                                                     throws javax.jmi.reflect.RefException

Throws:

javax.jmi.reflect.RefException

getFeatureDefinition

<T extends FeatureDefinition> List<T> getFeatureDefinition(FeatureDefinitionQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addFeatureDefinition

void addFeatureDefinition(String qualifiedName,
                          FeatureDefinition newValue)

Parameters:

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

newValue - The element to be appended.

addFeatureDefinition

void addFeatureDefinition(FeatureDefinition newValue)

Parameters:

newValue - The element to be appended.

removeFeatureDefinition

void removeFeatureDefinition(String qualifiedName)