org.opencrx.kernel.document1.cci
Interface DocumentFolder

All Superinterfaces:

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

All Known Implementing Classes:

DocumentFolderImpl

public interface DocumentFolder
extends Auditee, Indexed, SecureObject, BasicObject

Method Summary

String	getDescription() Retrieves the value for the attribute description.
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.
String	getName() Retrieves the value for the attribute name.
DocumentFolder	getParent() Retrieves the value for the optional reference parent.
void	removeParent() Removes the value for the optional reference parent.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setName(String newValue) Sets a new value for the attribute name.
void	setParent(DocumentFolder newValue) Sets a new value for the reference parent.

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

getAudit, getAudit, getAudit, getAudit

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.openmdx.base.cci.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

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

getContext, getContext

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

getIdentity

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

Method Detail

getDescription

String getDescription()

Retrieves the value for the attribute description.

Returns:

The non-null value for attribute description.

Throws:

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

setDescription

void setDescription(String newValue)

Sets a new value for the attribute description.

Parameters:

newValue - The non-null new value for attribute description.

Throws:

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

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.

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.

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

Throws:

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

setName

void setName(String newValue)

Sets a new value for the attribute name.

Parameters:

newValue - The non-null new value for attribute name.

Throws:

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

getParent

DocumentFolder getParent()

Retrieves the value for the optional reference parent.

Returns:

The possibly null value for this reference.

Throws:

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

setParent

void setParent(DocumentFolder newValue)

Sets a new value for the reference parent.

Parameters:

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

Throws:

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

removeParent

void removeParent()

Removes the value for the optional reference parent.

Throws:

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