org.opencrx.kernel.document1.cci2

Interface DocumentFolder

All Superinterfaces:

Auditee, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.Creatable, org.openmdx.base.cci2.ExtentCapable, Indexed, org.openmdx.base.cci2.Modifiable, PropertySetHolder, SecureObject

All Known Subinterfaces:

DocumentFolder

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

Class DocumentFolder

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentFolder.Identity Object Identity

Method Summary

Methods

Modifier and Type	Method and Description
CreateDefaultShareResult	createDefaultShare()
String	getDescription() Retrieves the possibly null value for the optional attribute description.
<T extends DocumentFolderEntry> FolderContainsDocument.FolderEntry<T>	getFolderEntry() Retrieves a set containing all the elements for the reference folderEntry.
<T extends DocumentFolderShare> DocumentFolderContainsFolderShare.FolderShare<T>	getFolderShare() Retrieves a set containing all the elements for the reference folderShare.
String	getName() Retrieves the value for the attribute name.
DocumentFolder	getParent() Retrieves the value for the reference parent.
<T extends DocumentFolder> FolderContainsFolder.SubFolder<T>	getSubFolder() Retrieves a set containing all the elements for the reference subFolder.
Boolean	isDisabled() Retrieves the possibly null value for the optional attribute disabled.
org.openmdx.base.cci2.Void	removeDefaultShare()
void	setDescription(String description) Sets a new value for the attribute description.
void	setDisabled(Boolean disabled) Sets a new value for the attribute disabled.
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

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

getIndexEntry, updateIndex

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

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

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

getPropertySet

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

getCreatedAt, getCreatedBy

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

getIdentity

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

getModifiedAt, getModifiedBy

Method Detail

createDefaultShare

CreateDefaultShareResult createDefaultShare()

getDescription

String getDescription()

Retrieves the possibly null value for the optional attribute description.

Returns:

The possibly null value for attribute description.

setDescription

void setDescription(String description)

Sets a new value for the attribute description.

Parameters:

description - The possibly null new value for attribute description.

isDisabled

Boolean isDisabled()

Retrieves the possibly null value for the optional attribute disabled.

Returns:

The possibly null value for attribute disabled.

setDisabled

void setDisabled(Boolean disabled)

Sets a new value for the attribute disabled.

Parameters:

disabled - The possibly null new value for attribute disabled.

getFolderEntry

<T extends DocumentFolderEntry> FolderContainsDocument.FolderEntry<T> getFolderEntry()

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

Returns:

A set containing all the elements for this reference.

getFolderShare

<T extends DocumentFolderShare> DocumentFolderContainsFolderShare.FolderShare<T> getFolderShare()

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

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 new – possibly null – value for this reference.

removeDefaultShare

org.openmdx.base.cci2.Void removeDefaultShare()

getSubFolder

<T extends DocumentFolder> FolderContainsFolder.SubFolder<T> getSubFolder()

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

Returns:

A set containing all the elements for this reference.