org.omg.model1.cci
Interface Segment

All Superinterfaces:
ContextCapable, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, Segment, ViewCapable

public interface Segment
extends Segment


Method Summary
 void addElement(Element newValue)
          Appends the specified element to the list of all the values for the reference element.
 void addElement(String qualifiedName, Element newValue)
          Appends the specified element to the list of all the values for the reference element for a specified qualifier attribute value.
 Void beginImport()
           
 Void beginImport(Void params)
           
 Void endImport()
           
 Void endImport(Void params)
           
 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 qualifiedName)
          Retrieves the value for the reference element for the specified qualifier attribute value.
 void removeElement(String qualifiedName)
          Removes the qualified (by means of the specified qualifier attribute value) element from the list of all the values for the reference element.
 
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

beginImport

Void beginImport(Void params)
                 throws RefException
Throws:
RefException

beginImport

Void beginImport()
                 throws RefException
Throws:
RefException

getElement

Element getElement(String qualifiedName)
Retrieves the value for the reference element 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.

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 qualifiedName,
                Element newValue)
Appends the specified element to the list of all the values for the reference element for a specified qualifier attribute value.

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.

addElement

void addElement(Element newValue)
Appends the specified element to the list of all the values for the reference element.

Parameters:
newValue - The element to be appended.
Throws:
JmiException - If the value cannot be appended for some reason.

removeElement

void removeElement(String qualifiedName)
Removes the qualified (by means of the specified qualifier attribute value) element from the list of all the values for the reference element.

Parameters:
qualifiedName - The qualifier attribute value that qualifies the reference to get the element to be removed.
Throws:
JmiException - If the value cannot be removed for some reason.

endImport

Void endImport(Void params)
               throws RefException
Throws:
RefException

endImport

Void endImport()
               throws RefException
Throws:
RefException


This software is published under the BSD license. Copyright © 2003-2008, OMEX AG, Switzerland, All rights reserved. Use is subject to license terms.