org.openmdx.base.cci
Interface Segment

All Superinterfaces:

ContextCapable, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, ViewCapable

All Known Subinterfaces:

Segment, Segment, Segment, Segment, Segment

All Known Implementing Classes:

SegmentImpl, SegmentImpl, SegmentImpl, SegmentImpl, SegmentImpl, SegmentImpl

public interface Segment
extends ContextCapable, ViewCapable

Method Summary

String	getDescription()
Collection	getExtent() Retrieves a collection containing all the elements for the reference extent.
List	getExtent(ExtentCapableFilter filter) Retrieves the value for the reference extent for the specified filter.
List	getExtent(ExtentCapableQuery query) Retrieves the value for the reference extent for the specified query.
ExtentCapable	getExtent(String identity) Retrieves the value for the reference extent for the specified qualifier attribute value.
Provider	getProvider() Retrieves the value for the reference provider.
void	setDescription(String newValue) Sets a new value for the attribute description.

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

getDescription

String getDescription()

Returns:

The possibly null value for attribute description.

Throws:

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

setDescription

void setDescription(String newValue)

Sets a new value for the attribute description.

Parameters:

newValue - The possibly null new value for attribute description.

Throws:

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

getExtent

ExtentCapable getExtent(String identity)

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

Parameters:

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

getExtent

Collection getExtent()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getExtent

List getExtent(ExtentCapableFilter filter)

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

getExtent

List getExtent(ExtentCapableQuery query)

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

getProvider

Provider getProvider()

Retrieves the value for the reference provider.

Returns:

The non-null value for this reference.

Throws:

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