org.opencrx.kernel.document1.jmi1

Interface Segment

All Superinterfaces:

Auditee, org.openmdx.base.cci2.ContextCapable, Exporter, Importer, Indexed, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, org.openmdx.base.accessor.jmi.cci.RefObject_1_0, SecureObject, org.openmdx.base.cci2.Segment

public interface Segment
extends Segment, Segment, Auditee, Exporter, Importer, Indexed, SecureObject

Class Segment

Nested Class Summary

Nested classes/interfaces inherited from interface org.openmdx.base.cci2.Segment

org.openmdx.base.cci2.Segment.Identity

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocument(boolean idIsPersistent, String id, Document document) Adds the specified element to the set of the values for the reference document.
void	addDocument(Document document) Adds the specified element to the set of the values for the reference document using an implementation-specific, reassignable qualifier.
void	addDocument(String id, Document document) Adds the specified element to the set of the values for the reference document using a reassignable qualifier.
void	addDocumentFilter(boolean idIsPersistent, String id, DocumentFilterGlobal documentFilter) Adds the specified element to the set of the values for the reference documentFilter.
void	addDocumentFilter(DocumentFilterGlobal documentFilter) Adds the specified element to the set of the values for the reference documentFilter using an implementation-specific, reassignable qualifier.
void	addDocumentFilter(String id, DocumentFilterGlobal documentFilter) Adds the specified element to the set of the values for the reference documentFilter using a reassignable qualifier.
void	addFolder(boolean idIsPersistent, String id, DocumentFolder folder) Adds the specified element to the set of the values for the reference folder.
void	addFolder(DocumentFolder folder) Adds the specified element to the set of the values for the reference folder using an implementation-specific, reassignable qualifier.
void	addFolder(String id, DocumentFolder folder) Adds the specified element to the set of the values for the reference folder using a reassignable qualifier.
Document	getDocument(boolean idIsPersistent, String id) Retrieves the value for the reference document for the specified qualifier attribute value.
<T extends Document> List<T>	getDocument(DocumentQuery query) Retrieves the value for the reference document for the specified query.
Document	getDocument(String id) Retrieves the value for the reference document for the specified qualifier attribute value.
DocumentFilterGlobal	getDocumentFilter(boolean idIsPersistent, String id) Retrieves the value for the reference documentFilter for the specified qualifier attribute value.
<T extends DocumentFilterGlobal> List<T>	getDocumentFilter(DocumentFilterGlobalQuery query) Retrieves the value for the reference documentFilter for the specified query.
DocumentFilterGlobal	getDocumentFilter(String id) Retrieves the value for the reference documentFilter for the specified qualifier attribute value.
DocumentFolder	getFolder(boolean idIsPersistent, String id) Retrieves the value for the reference folder for the specified qualifier attribute value.
<T extends DocumentFolder> List<T>	getFolder(DocumentFolderQuery query) Retrieves the value for the reference folder for the specified query.
DocumentFolder	getFolder(String id) Retrieves the value for the reference folder for the specified qualifier attribute value.

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

getDocument, getDocumentFilter, getFolder

Methods inherited from interface org.openmdx.base.jmi1.Segment

getExtent, getExtent, getExtent, getProvider

Methods inherited from interface org.openmdx.base.cci2.Segment

getDescription, getExtent, setDescription

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

Methods inherited from interface org.opencrx.kernel.base.jmi1.Auditee

getAudit, getAudit, getAudit

Methods inherited from interface org.opencrx.kernel.base.cci2.Auditee

getAudit

Methods inherited from interface org.opencrx.kernel.base.jmi1.Exporter

exportItem, exportItemAdvanced

Methods inherited from interface org.opencrx.kernel.base.cci2.Exporter

exportItem, exportItemAdvanced

Methods inherited from interface org.opencrx.kernel.base.jmi1.Importer

importItem

Methods inherited from interface org.opencrx.kernel.base.cci2.Importer

importItem

Methods inherited from interface org.opencrx.kernel.base.jmi1.Indexed

getIndexEntry, getIndexEntry, getIndexEntry, updateIndex

Methods inherited from interface org.opencrx.kernel.base.cci2.Indexed

getIndexEntry

Methods inherited from interface org.opencrx.kernel.base.jmi1.SecureObject

addOwningGroup, checkPermissions, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwner, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser

Method Detail

getDocument

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

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

getDocument

Document getDocument(boolean idIsPersistent,
                   String id)

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

getDocument

Document getDocument(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addDocument

void addDocument(boolean idIsPersistent,
               String id,
               Document document)

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

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.

document - The element to be appended.

addDocument

void addDocument(String id,
               Document document)

Adds the specified element to the set of the values for the reference document 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.

document - The element to be appended.

addDocument

void addDocument(Document document)

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

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

Parameters:

document - The element to be appended.

getDocumentFilter

<T extends DocumentFilterGlobal> List<T> getDocumentFilter(DocumentFilterGlobalQuery query)

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

getDocumentFilter

DocumentFilterGlobal getDocumentFilter(boolean idIsPersistent,
                                     String id)

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

getDocumentFilter

DocumentFilterGlobal getDocumentFilter(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addDocumentFilter

void addDocumentFilter(boolean idIsPersistent,
                     String id,
                     DocumentFilterGlobal documentFilter)

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

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.

documentFilter - The element to be appended.

addDocumentFilter

void addDocumentFilter(String id,
                     DocumentFilterGlobal documentFilter)

Adds the specified element to the set of the values for the reference documentFilter 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.

documentFilter - The element to be appended.

addDocumentFilter

void addDocumentFilter(DocumentFilterGlobal documentFilter)

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

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

Parameters:

documentFilter - The element to be appended.

getFolder

<T extends DocumentFolder> List<T> getFolder(DocumentFolderQuery query)

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

getFolder

DocumentFolder getFolder(boolean idIsPersistent,
                       String id)

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

getFolder

DocumentFolder getFolder(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addFolder

void addFolder(boolean idIsPersistent,
             String id,
             DocumentFolder folder)

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

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.

folder - The element to be appended.

addFolder

void addFolder(String id,
             DocumentFolder folder)

Adds the specified element to the set of the values for the reference folder 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.

folder - The element to be appended.

addFolder

void addFolder(DocumentFolder folder)

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

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

Parameters:

folder - The element to be appended.