org.opencrx.kernel.document1.jmi1
Interface DocumentFolder

All Superinterfaces:

Auditee, BasicObject, ContextCapable, DocumentFolder, ExtentCapable, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, ViewCapable

public interface DocumentFolder
extends DocumentFolder, Auditee, Indexed, SecureObject, BasicObject

Class DocumentFolder

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencrx.kernel.document1.cci2.DocumentFolder

DocumentFolder.Identity

Method Summary

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.
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.
DocumentFolder	getParent() Retrieves the value for the reference parent.
void	setParent(DocumentFolder parent) Sets a new value for the reference parent.

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

getDescription, getDocument, getFolder, getName, setDescription, setName

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.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, getAccessGrantedByParent, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setOwningUser, setOwningUser

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

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

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

getCreatedBy, getModifiedBy

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

getCreatedAt, getModifiedAt

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

getContext

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

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.jmi1.ViewCapable

getView, getView, getView

Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable

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

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

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

getParent

DocumentFolder getParent()

Retrieves the value for the reference parent.

Specified by:

getParent in interface DocumentFolder

Returns:

The – possibly null – value for this reference.

setParent

void setParent(DocumentFolder parent)

Sets a new value for the reference parent.

Specified by:

setParent in interface DocumentFolder

Parameters:

parent - The non-null new value for this reference.