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.accessor.jmi.cci.RefObject_1_0, 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(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.jmi1.Void	assertInspector(SegmentAssertInspectorParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..
org.openmdx.base.jmi1.Void	assertInspector(String forClass)
SegmentExportElementsResult	exportElements(boolean includeAutoGenerated)
SegmentExportElementsResult	exportElements(SegmentExportElementsParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..
<T extends AssertableInspector> List<T>	getAssertableInspector(AssertableInspectorQuery query) Retrieves the value for the reference assertableInspector for the specified query.
AssertableInspector	getAssertableInspector(boolean nameIsPersistent, String name) Retrieves the value for the reference assertableInspector for the specified qualifier attribute value.
AssertableInspector	getAssertableInspector(String name) Retrieves the value for the reference assertableInspector for the specified qualifier attribute value.
Element	getElement(boolean idIsPersistent, String id) Retrieves the value for the reference element for the specified qualifier attribute value.
<T extends Element> List<T>	getElement(ElementQuery query) Retrieves the value for the reference element for the specified query.
Element	getElement(String id) Retrieves the value for the reference element for the specified qualifier attribute value.
ElementDefinition	getElementDefinition(boolean nameIsPersistent, String name) Retrieves the value for the reference elementDefinition for the specified qualifier attribute value.
<T extends ElementDefinition> List<T>	getElementDefinition(ElementDefinitionQuery query) Retrieves the value for the reference elementDefinition for the specified query.
ElementDefinition	getElementDefinition(String name) Retrieves the value for the reference elementDefinition for the specified qualifier attribute value.
FeatureDefinition	getFeatureDefinition(boolean qualifiedNameIsPersistent, String qualifiedName) Retrieves the value for the reference featureDefinition for the specified qualifier attribute value.
<T extends FeatureDefinition> List<T>	getFeatureDefinition(FeatureDefinitionQuery query) Retrieves the value for the reference featureDefinition for the specified query.
FeatureDefinition	getFeatureDefinition(String qualifiedName) Retrieves the value for the reference featureDefinition for the specified qualifier attribute value.

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

addElement, addElementDefinition, addFeatureDefinition, getAssertableInspector, getElement, getElementDefinition, getFeatureDefinition

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

getExtent, getExtent, getExtent, getProvider

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

getDescription, setDescription

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

getView, getView, getView

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

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

Method Detail

assertInspector

org.openmdx.base.jmi1.Void assertInspector(SegmentAssertInspectorParams params)
                                           throws javax.jmi.reflect.RefException

Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature..

Throws:

javax.jmi.reflect.RefException

assertInspector

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

getAssertableInspector

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

Retrieves the value for the reference assertableInspector for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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

getAssertableInspector

AssertableInspector getAssertableInspector(String name)

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

This method is equivalent to the preferred invocation getAssertableInspector(false,name).

Parameters:

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

Returns:

The possibly null value for this qualifier

getElement

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

Retrieves the value for the reference element for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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

getElement

Element getElement(String id)

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

This method is equivalent to the preferred invocation getElement(false,id).

Parameters:

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> List<T> getElementDefinition(ElementDefinitionQuery query)

Retrieves the value for the reference elementDefinition for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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

getElementDefinition

ElementDefinition getElementDefinition(String name)

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

This method is equivalent to the preferred invocation getElementDefinition(false,name).

Parameters:

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(SegmentExportElementsParams params)
                                           throws javax.jmi.reflect.RefException

Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature..

Throws:

javax.jmi.reflect.RefException

exportElements

SegmentExportElementsResult exportElements(boolean includeAutoGenerated)

getFeatureDefinition

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

Retrieves the value for the reference featureDefinition for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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

getFeatureDefinition

FeatureDefinition getFeatureDefinition(String qualifiedName)

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

This method is equivalent to the preferred invocation getFeatureDefinition(false,qualifiedName).

Parameters:

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.