org.openmdx.filter1.cci
Interface Filter

All Superinterfaces:

RefBaseObject, RefFeatured, RefObject, RefObject_1_0

All Known Subinterfaces:

ModelReferencePrivilege

All Known Implementing Classes:

FilterImpl, ModelReferencePrivilegeImpl

public interface Filter
extends RefObject_1_0

Method Summary

void	addProperty(Property newValue)
void	addProperty(String name, Property newValue)
Collection	getProperty() Retrieves a collection containing all the elements for the reference property.
List	getProperty(PropertyFilter filter) Retrieves the value for the reference property for the specified filter.
List	getProperty(PropertyQuery query) Retrieves the value for the reference property for the specified query.
Property	getProperty(String name) Retrieves the value for the reference property for the specified qualifier attribute value.
void	removeProperty(String name)

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

getProperty

Property getProperty(String name)

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

getProperty

Collection getProperty()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getProperty

List getProperty(PropertyFilter filter)

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

getProperty

List getProperty(PropertyQuery query)

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

addProperty

void addProperty(String name,
                 Property 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.

addProperty

void addProperty(Property newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeProperty

void removeProperty(String name)

Throws:

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