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> Set<T>	getDocument() Retrieves a set containing all the elements for the reference document.
<T extends DocumentFolder> Set<T>	getFolder() Retrieves a set containing all the elements for the reference folder.
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.
void	setSegment(Segment segment) Sets a new value for the reference segment.
void	setSegment(Segment segment, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:document1:SegmentContainsFolder.

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

getAudit

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

getIndexEntry, updateIndex

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

addOwningGroup, 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

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> Set<T> getDocument()

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

Returns:

A set containing all the elements for this reference.

getFolder

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

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

Returns:

A set containing all the elements for this reference.

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.

setSegment

void setSegment(Segment segment)

Sets a new value for the reference segment.

Parameters:

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

setSegment

void setSegment(Segment segment,
                boolean idIsPersistent,
                String id)

Set the object's composite association org:opencrx:kernel:document1:SegmentContainsFolder.

Parameters:

segment - The non-null new value for this object's composite owner.

idIsPersistent - Defines whether the id is persistent.

id - The non-null new value for this object's qualifier.