org.opencrx.kernel.document1.jmi1
Interface DocumentFolder

All Superinterfaces:

Auditee, BasicObject, ContextCapable, Creatable, DocumentFolder, ExtentCapable, Indexed, Modifiable, PropertySetHolder, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject

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

Class DocumentFolder

Nested Class Summary

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

DocumentFolder.Identity

Method Summary

DocumentFolderEntry	getFolderEntry(boolean idIsPersistent, String id) Retrieves the value for the reference folderEntry for the specified qualifier attribute value.
<T extends DocumentFolderEntry> List<T>	getFolderEntry(DocumentFolderEntryQuery query) Retrieves the value for the reference folderEntry for the specified query.
DocumentFolderEntry	getFolderEntry(String id) Retrieves the value for the reference folderEntry for the specified qualifier attribute value.
DocumentFolder	getParent() Retrieves the value for the reference parent.
DocumentFolder	getSubFolder(boolean idIsPersistent, String id) Retrieves the value for the reference subFolder for the specified qualifier attribute value.
<T extends DocumentFolder> List<T>	getSubFolder(DocumentFolderQuery query) Retrieves the value for the reference subFolder for the specified query.
DocumentFolder	getSubFolder(String id) Retrieves the value for the reference subFolder for the specified qualifier attribute value.
void	setParent(DocumentFolder parent) Sets a new value for the reference parent.

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

getDescription, getFolderEntry, getName, getSubFolder, isDisabled, setDescription, setDisabled, 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, 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

Methods inherited from interface org.opencrx.kernel.document1.jmi1.PropertySetHolder

addPropertySet, addPropertySet, addPropertySet, getPropertySet, getPropertySet, getPropertySet

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

getPropertySet

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

getCreatedBy

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

getCreatedAt

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

getIdentity

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

getModifiedBy

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

getModifiedAt

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

getFolderEntry

<T extends DocumentFolderEntry> List<T> getFolderEntry(DocumentFolderEntryQuery query)

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

getFolderEntry

DocumentFolderEntry getFolderEntry(boolean idIsPersistent,
                                   String id)

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

getFolderEntry

DocumentFolderEntry getFolderEntry(String id)

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

This method is equivalent to the preferred invocation getFolderEntry(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 new – possibly null – value for this reference.

getSubFolder

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

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

getSubFolder

DocumentFolder getSubFolder(boolean idIsPersistent,
                            String id)

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

getSubFolder

DocumentFolder getSubFolder(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier