org.openmdx.ui1.cci
Interface Segment

All Superinterfaces:

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

public interface Segment
extends Segment

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)
Void	assertInspector(SegmentAssertInspectorParams params)
Void	assertInspector(String forClass)
SegmentExportElementsResult	exportElements(boolean includeAutoGenerated)
SegmentExportElementsResult	exportElements(SegmentExportElementsParams params)
Collection	getAssertableInspector() Retrieves a collection containing all the elements for the reference assertableInspector.
List	getAssertableInspector(AssertableInspectorFilter filter) Retrieves the value for the reference assertableInspector for the specified filter.
List	getAssertableInspector(AssertableInspectorQuery query) Retrieves the value for the reference assertableInspector for the specified query.
AssertableInspector	getAssertableInspector(String name) Retrieves the value for the reference assertableInspector for the specified qualifier attribute value.
Collection	getElement() Retrieves a collection containing all the elements for the reference element.
List	getElement(ElementFilter filter) Retrieves the value for the reference element for the specified filter.
List	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.
Collection	getElementDefinition() Retrieves a collection containing all the elements for the reference elementDefinition.
List	getElementDefinition(ElementDefinitionFilter filter) Retrieves the value for the reference elementDefinition for the specified filter.
List	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.
Collection	getFeatureDefinition() Retrieves a collection containing all the elements for the reference featureDefinition.
List	getFeatureDefinition(FeatureDefinitionFilter filter) Retrieves the value for the reference featureDefinition for the specified filter.
List	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.
void	removeElement(String id)
void	removeElementDefinition(String name)
void	removeFeatureDefinition(String qualifiedName)

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

getDescription, getExtent, getExtent, getExtent, getExtent, getProvider, setDescription

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

getContext, getContext

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

Method Detail

assertInspector

Void assertInspector(SegmentAssertInspectorParams params)
                     throws javax.jmi.reflect.RefException

Throws:

javax.jmi.reflect.RefException

assertInspector

Void assertInspector(String forClass)
                     throws javax.jmi.reflect.RefException

Throws:

javax.jmi.reflect.RefException

getAssertableInspector

AssertableInspector getAssertableInspector(String name)

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

Parameters:

name - 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.

getAssertableInspector

Collection getAssertableInspector()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getAssertableInspector

List getAssertableInspector(AssertableInspectorFilter filter)

Retrieves the value for the reference assertableInspector 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.

getAssertableInspector

List getAssertableInspector(AssertableInspectorQuery query)

Retrieves the value for the reference assertableInspector 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.

getElement

Element getElement(String id)

Retrieves the value for the reference element 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.

getElement

Collection getElement()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getElement

List getElement(ElementFilter filter)

Retrieves the value for the reference element 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.

getElement

List getElement(ElementQuery query)

Retrieves the value for the reference element 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.

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.

Throws:

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

addElement

void addElement(Element newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeElement

void removeElement(String id)

Throws:

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

getElementDefinition

ElementDefinition getElementDefinition(String name)

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

Parameters:

name - 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.

getElementDefinition

Collection getElementDefinition()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getElementDefinition

List getElementDefinition(ElementDefinitionFilter filter)

Retrieves the value for the reference elementDefinition 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.

getElementDefinition

List getElementDefinition(ElementDefinitionQuery query)

Retrieves the value for the reference elementDefinition 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.

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.

Throws:

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

addElementDefinition

void addElementDefinition(ElementDefinition newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeElementDefinition

void removeElementDefinition(String name)

Throws:

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

exportElements

SegmentExportElementsResult exportElements(SegmentExportElementsParams params)
                                           throws javax.jmi.reflect.RefException

Throws:

javax.jmi.reflect.RefException

exportElements

SegmentExportElementsResult exportElements(boolean includeAutoGenerated)
                                           throws javax.jmi.reflect.RefException

Throws:

javax.jmi.reflect.RefException

getFeatureDefinition

FeatureDefinition getFeatureDefinition(String qualifiedName)

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

Parameters:

qualifiedName - 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.

getFeatureDefinition

Collection getFeatureDefinition()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getFeatureDefinition

List getFeatureDefinition(FeatureDefinitionFilter filter)

Retrieves the value for the reference featureDefinition 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.

getFeatureDefinition

List getFeatureDefinition(FeatureDefinitionQuery query)

Retrieves the value for the reference featureDefinition 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.

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.

Throws:

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

addFeatureDefinition

void addFeatureDefinition(FeatureDefinition newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeFeatureDefinition

void removeFeatureDefinition(String qualifiedName)

Throws:

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