org.opencrx.kernel.document1.cci2

Interface DocumentFolderEntry

All Superinterfaces:

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

All Known Subinterfaces:

AssignmentBasedFolderEntry, AssignmentBasedFolderEntry, DocumentBasedFolderEntry, DocumentBasedFolderEntry, DocumentFolderEntry

public interface DocumentFolderEntry
extends SecureObject, org.openmdx.base.cci2.BasicObject

Abstract class DocumentFolderEntry

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
short	getAssignmentRole() Retrieves the value for the attribute assignmentRole.
org.openmdx.base.cci2.BasicObject	getBasedOn() Retrieves the value for the reference basedOn.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
org.openmdx.base.cci2.BasicObject	getDocument() Retrieves the value for the reference document.
String	getName() Retrieves the value for the attribute name.
Date	getValidFrom() Retrieves the possibly null value for the optional attribute validFrom.
Date	getValidTo() Retrieves the possibly null value for the optional attribute validTo.
Boolean	isDisabled() Retrieves the possibly null value for the optional attribute disabled.
void	setAssignmentRole(short assignmentRole) Sets a new value for the attribute assignmentRole.
void	setBasedOn(org.openmdx.base.cci2.BasicObject basedOn) Sets a new value for the reference basedOn.
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	setDocument(org.openmdx.base.cci2.BasicObject document) Sets a new value for the reference document.
void	setName(String name) Sets a new value for the attribute name.
void	setValidFrom(Date validFrom) Sets a new value for the attribute validFrom.
void	setValidTo(Date validTo) Sets a new value for the attribute validTo.

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.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

getAssignmentRole

short getAssignmentRole()

Retrieves the value for the attribute assignmentRole.

Returns:

The non-null value for attribute assignmentRole.

setAssignmentRole

void setAssignmentRole(short assignmentRole)

Sets a new value for the attribute assignmentRole.

Parameters:

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

getBasedOn

org.openmdx.base.cci2.BasicObject getBasedOn()

Retrieves the value for the reference basedOn.

Returns:

The – possibly null – value for this reference.

setBasedOn

void setBasedOn(org.openmdx.base.cci2.BasicObject basedOn)

Sets a new value for the reference basedOn.

Parameters:

basedOn - The new – possibly null – value for this reference.

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.

getDocument

org.openmdx.base.cci2.BasicObject getDocument()

Retrieves the value for the reference document.

Returns:

The – possibly null – value for this reference.

setDocument

void setDocument(org.openmdx.base.cci2.BasicObject document)

Sets a new value for the reference document.

Parameters:

document - The new – possibly null – value 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.

getValidFrom

Date getValidFrom()

Retrieves the possibly null value for the optional attribute validFrom.

Returns:

The possibly null value for attribute validFrom.

setValidFrom

void setValidFrom(Date validFrom)

Sets a new value for the attribute validFrom.

Parameters:

validFrom - The possibly null new value for attribute validFrom.

getValidTo

Date getValidTo()

Retrieves the possibly null value for the optional attribute validTo.

Returns:

The possibly null value for attribute validTo.

setValidTo

void setValidTo(Date validTo)

Sets a new value for the attribute validTo.

Parameters:

validTo - The possibly null new value for attribute validTo.