org.opencrx.kernel.document1.jmi1

Interface AbstractFilterDocument

All Superinterfaces:

AbstractFilter, AbstractFilterDocument, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, org.openmdx.base.accessor.jmi.cci.RefObject_1_0

All Known Subinterfaces:

DocumentFilterGlobal

public interface AbstractFilterDocument
extends AbstractFilterDocument, AbstractFilter

Abstract class AbstractFilterDocument

Method Summary

Methods

Modifier and Type	Method and Description
void	addFilteredDocument(boolean idIsPersistent, String id, Document filteredDocument) Adds the specified element to the set of the values for the reference filteredDocument.
void	addFilteredDocument(Document filteredDocument) Adds the specified element to the set of the values for the reference filteredDocument using an implementation-specific, reassignable qualifier.
void	addFilteredDocument(String id, Document filteredDocument) Adds the specified element to the set of the values for the reference filteredDocument using a reassignable qualifier.
void	addFilterProperty(boolean idIsPersistent, String id, DocumentFilterProperty filterProperty) Adds the specified element to the set of the values for the reference filterProperty.
void	addFilterProperty(DocumentFilterProperty filterProperty) Adds the specified element to the set of the values for the reference filterProperty using an implementation-specific, reassignable qualifier.
void	addFilterProperty(String id, DocumentFilterProperty filterProperty) Adds the specified element to the set of the values for the reference filterProperty using a reassignable qualifier.
CountFilteredObjectsResult	countFilteredDocument()
Document	getFilteredDocument(boolean idIsPersistent, String id) Retrieves the value for the reference filteredDocument for the specified qualifier attribute value.
<T extends Document> List<T>	getFilteredDocument(DocumentQuery query) Retrieves the value for the reference filteredDocument for the specified query.
Document	getFilteredDocument(String id) Retrieves the value for the reference filteredDocument for the specified qualifier attribute value.
DocumentFilterProperty	getFilterProperty(boolean idIsPersistent, String id) Retrieves the value for the reference filterProperty for the specified qualifier attribute value.
<T extends DocumentFilterProperty> List<T>	getFilterProperty(DocumentFilterPropertyQuery query) Retrieves the value for the reference filterProperty for the specified query.
DocumentFilterProperty	getFilterProperty(String id) Retrieves the value for the reference filterProperty for the specified qualifier attribute value.

Methods inherited from interface org.opencrx.kernel.document1.cci2.AbstractFilterDocument

getFilteredDocument, getFilterProperty

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refDefaultFetchGroup, refDelegate, refGetPath, refGetValue, refInitialize, refInitialize, refSetValue

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

countFilteredDocument

CountFilteredObjectsResult countFilteredDocument()

Specified by:

countFilteredDocument in interface AbstractFilterDocument

getFilterProperty

<T extends DocumentFilterProperty> List<T> getFilterProperty(DocumentFilterPropertyQuery query)

Retrieves the value for the reference filterProperty for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

query - predicate which is applied to the set of referenced objects.

Returns:

The objects for which the predicate evaluates to true.

getFilterProperty

DocumentFilterProperty getFilterProperty(boolean idIsPersistent,
                                       String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

getFilterProperty

DocumentFilterProperty getFilterProperty(String id)

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

This method is equivalent to the preferred invocation getFilterProperty(false,id).

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

addFilterProperty

void addFilterProperty(boolean idIsPersistent,
                     String id,
                     DocumentFilterProperty filterProperty)

Adds the specified element to the set of the values for the reference filterProperty.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

filterProperty - The element to be appended.

addFilterProperty

void addFilterProperty(String id,
                     DocumentFilterProperty filterProperty)

Adds the specified element to the set of the values for the reference filterProperty using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

filterProperty - The element to be appended.

addFilterProperty

void addFilterProperty(DocumentFilterProperty filterProperty)

Adds the specified element to the set of the values for the reference filterProperty using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

filterProperty - The element to be appended.

getFilteredDocument

<T extends Document> List<T> getFilteredDocument(DocumentQuery query)

Retrieves the value for the reference filteredDocument for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

query - predicate which is applied to the set of referenced objects.

Returns:

The objects for which the predicate evaluates to true.

getFilteredDocument

Document getFilteredDocument(boolean idIsPersistent,
                           String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

getFilteredDocument

Document getFilteredDocument(String id)

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

This method is equivalent to the preferred invocation getFilteredDocument(false,id).

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

addFilteredDocument

void addFilteredDocument(boolean idIsPersistent,
                       String id,
                       Document filteredDocument)

Adds the specified element to the set of the values for the reference filteredDocument.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

filteredDocument - The element to be appended.

addFilteredDocument

void addFilteredDocument(String id,
                       Document filteredDocument)

Adds the specified element to the set of the values for the reference filteredDocument using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

filteredDocument - The element to be appended.

addFilteredDocument

void addFilteredDocument(Document filteredDocument)

Adds the specified element to the set of the values for the reference filteredDocument using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

filteredDocument - The element to be appended.