org.opencrx.kernel.document1.cci2
Interface DocumentFolder

All Superinterfaces:

Auditee, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, Indexed, SecureObject, org.openmdx.compatibility.view1.cci2.ViewCapable

All Known Subinterfaces:

DocumentFolder

All Known Implementing Classes:

DocumentFolder

public interface DocumentFolder
extends Auditee, Indexed, SecureObject, org.openmdx.base.cci2.BasicObject

Class DocumentFolder

Nested Class Summary

static interface

DocumentFolder.Identity Object Identity

Method Summary

String	getDescription() Retrieves the value for the attribute description.
<T extends Document> Collection<T>	getDocument() Retrieves a set containing all the elements for the reference document.
Document	getDocument(boolean idIsPersistent, String id) Retrieves the value for the reference document for the specified qualifier attribute value.
<T extends DocumentFolder> Collection<T>	getFolder() Retrieves a set containing all the elements for the reference folder.
DocumentFolder	getFolder(boolean idIsPersistent, 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 reference parent.
void	setDescription(String description) Sets a new value for the attribute description.
void	setName(String name) Sets a new value for the attribute name.
void	setParent(DocumentFolder parent) Sets a new value for the reference parent.

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

getAudit, getAudit

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

getIndexEntry, getIndexEntry, updateIndex

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

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

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

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

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

getIdentity

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

getView, getView

Method Detail

getDescription

String getDescription()

Retrieves the value for the attribute description.

Returns:

The non-null value for attribute description.

setDescription

void setDescription(String description)

Sets a new value for the attribute description.

Parameters:

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

getDocument

<T extends Document> Collection<T> getDocument()

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

Returns:

A set containing all the elements for this reference.

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

getFolder

<T extends DocumentFolder> Collection<T> getFolder()

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

Returns:

A set containing all the elements for this reference.

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

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

setName

void setName(String name)

Sets a new value for the attribute name.

Parameters:

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

getParent

DocumentFolder getParent()

Retrieves the value for the reference parent.

Returns:

The – possibly null – value for this reference.

setParent

void setParent(DocumentFolder parent)

Sets a new value for the reference parent.

Parameters:

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