org.openmdx.base.cci
Interface Provider

All Superinterfaces:

RefBaseObject, RefFeatured, RefObject, RefObject_1_0

All Known Implementing Classes:

ProviderImpl

public interface Provider
extends RefObject_1_0

Method Summary

void	addSegment(Segment newValue) Appends the specified element to the list of all the values for the reference segment.
void	addSegment(String qualifiedName, Segment newValue) Appends the specified element to the list of all the values for the reference segment for a specified qualifier attribute value.
Authority	getAuthority() Retrieves the value for the reference authority.
Collection	getSegment() Retrieves a collection containing all the elements for the reference segment.
List	getSegment(SegmentFilter filter) Retrieves the value for the reference segment for the specified filter.
List	getSegment(SegmentQuery query) Retrieves the value for the reference segment for the specified query.
Segment	getSegment(String qualifiedName) Retrieves the value for the reference segment for the specified qualifier attribute value.
void	removeSegment(String qualifiedName) Removes the qualified (by means of the specified qualifier attribute value) element from the list of all the values for the reference segment.

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

getAuthority

Authority getAuthority()

Retrieves the value for the reference authority.

Returns:

The non-null value for this reference.

Throws:

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

getSegment

Segment getSegment(String qualifiedName)

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

getSegment

Collection getSegment()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getSegment

List getSegment(SegmentFilter filter)

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

getSegment

List getSegment(SegmentQuery query)

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

addSegment

void addSegment(String qualifiedName,
                Segment newValue)

Appends the specified element to the list of all the values for the reference segment 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.

addSegment

void addSegment(Segment newValue)

Appends the specified element to the list of all the values for the reference segment.

Parameters:

newValue - The element to be appended.

Throws:

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

removeSegment

void removeSegment(String qualifiedName)

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

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.