org.opencrx.kernel.document1.cci
Interface Segment

All Superinterfaces:

Auditee, ContextCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, Segment, ViewCapable, XmlExporter

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

Method Summary

void	addDocument(Document newValue)
void	addDocument(String id, Document newValue)
void	addFolder(DocumentFolder newValue)
void	addFolder(String id, DocumentFolder newValue)
Collection	getDocument() Retrieves a collection containing all the elements for the reference document.
List	getDocument(DocumentFilter filter) Retrieves the value for the reference document for the specified filter.
List	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.
Collection	getFolder() Retrieves a collection containing all the elements for the reference folder.
List	getFolder(DocumentFolderFilter filter) Retrieves the value for the reference folder for the specified filter.
List	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.
void	removeDocument(String id)
void	removeFolder(String id)

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

getDescription, getExtent, getExtent, getExtent, getExtent, getProvider, setDescription

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

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

getAudit, getAudit, getAudit, getAudit

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

addOwningGroup, addOwningGroup, addOwningGroup, addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwner, getOwningGroup, getOwningGroup, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningUser, setAccessLevel, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci.XmlExporter

exportXml, exportXml

Method Detail

getDocument

Document getDocument(String id)

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

Parameters:

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

getDocument

Collection getDocument()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getDocument

List getDocument(DocumentFilter filter)

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

getDocument

List getDocument(DocumentQuery query)

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

addDocument

void addDocument(String id,
                 Document newValue)

Parameters:

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

addDocument

void addDocument(Document newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeDocument

void removeDocument(String id)

Throws:

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

getFolder

DocumentFolder getFolder(String id)

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

Parameters:

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

getFolder

Collection getFolder()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getFolder

List getFolder(DocumentFolderFilter filter)

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

getFolder

List getFolder(DocumentFolderQuery query)

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

addFolder

void addFolder(String id,
               DocumentFolder newValue)

Parameters:

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

addFolder

void addFolder(DocumentFolder newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeFolder

void removeFolder(String id)

Throws:

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