Document (openCRX/Core API)

All Superinterfaces:

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

All Known Subinterfaces:

Document
```
public interface Document
extends Auditee, Exporter, Importer, Indexed, SecureObject, PropertySetHolder, org.openmdx.base.cci2.BasicObject
```
Class Document

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Document.Identity
Object Identity

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Document.Identity` Object Identity

Method Summary

Methods
Modifier and Type	Method and Description
`Date`	`getActiveOn()` Retrieves the possibly null value for the optional attribute `activeOn`.
`Date`	`getActiveUntil()` Retrieves the possibly null value for the optional attribute `activeUntil`.
`<T extends DocumentAttachment> DocumentHasAttachment.Attachment<T>`	`getAttachment()` Retrieves a set containing all the elements for the reference `attachment`.
`String`	`getAuthor()` Retrieves the possibly null value for the optional attribute `author`.
`String`	`getCmsClass()` Retrieves the possibly null value for the optional attribute `cmsClass`.
`String`	`getCmsDefaultLanguage()` Retrieves the possibly null value for the optional attribute `cmsDefaultLanguage`.
`String`	`getCmsLanguage()` Retrieves the possibly null value for the optional attribute `cmsLanguage`.
`String`	`getCmsMeta()` Retrieves the possibly null value for the optional attribute `cmsMeta`.
`String`	`getCmsTemplate()` Retrieves the possibly null value for the optional attribute `cmsTemplate`.
`Integer`	`getCmsTranslation()` Retrieves the possibly null value for the optional attribute `cmsTranslation`.
`List<Short>`	`getContentLanguage()` Retrieves a list containing all the elements for the attribute `contentLanguage`.
`Integer`	`getContentLength()` Retrieves the possibly null value for the optional attribute `contentLength`.
`String`	`getContentType()` Retrieves the possibly null value for the optional attribute `contentType`.
`String`	`getDescription()` Retrieves the possibly null value for the optional attribute `description`.
`String`	`getDocumentAbstract()` Retrieves the possibly null value for the optional attribute `documentAbstract`.
`<T extends FolderAssignment> DocumentHasDocumentFolderAssignment.DocumentFolderAssignment<T>`	`getDocumentFolderAssignment()` Retrieves a set containing all the elements for the reference `documentFolderAssignment`.
`String`	`getDocumentNumber()` Retrieves the possibly null value for the optional attribute `documentNumber`.
`<T extends DocumentReference> DocumentHasDocumentReference.DocumentReference<T>`	`getDocumentReference()` Retrieves a set containing all the elements for the reference `documentReference`.
`short`	`getDocumentState()` Retrieves the value for the attribute `documentState`.
`short`	`getDocumentType()` Retrieves the value for the attribute `documentType`.
`<T extends DocumentFolder> List<T>`	`getFolder()` Retrieves the `Collection` of objects referenced by `folder`.
`DocumentRevision`	`getHeadRevision()` Retrieves the value for the reference `headRevision`.
`String`	`getKeywords()` Retrieves the possibly null value for the optional attribute `keywords`.
`<T extends DocumentLink> DocumentContainsLink.Link<T>`	`getLink()` Retrieves a set containing all the elements for the reference `link`.
`short`	`getLiteratureType()` Retrieves the value for the attribute `literatureType`.
`String`	`getLocation()` Retrieves the possibly null value for the optional attribute `location`.
`<T extends DocumentLock> DocumentHasLocks.Lock<T>`	`getLock()` Retrieves a set containing all the elements for the reference `lock`.
`String`	`getName()` Retrieves the value for the attribute `name`.
`Document`	`getParent()` Retrieves the value for the reference `parent`.
`String`	`getQualifiedName()` Retrieves the possibly null value for the optional attribute `qualifiedName`.
`<T extends DocumentRevision> DocumentHasRevision.Revision<T>`	`getRevision()` Retrieves a set containing all the elements for the reference `revision`.
`String`	`getSearchText()` Retrieves the possibly null value for the optional attribute `searchText`.
`String`	`getTitle()` Retrieves the possibly null value for the optional attribute `title`.
`Boolean`	`isDisabled()` Retrieves the possibly null value for the optional attribute `disabled`.
`void`	`setActiveOn(Date activeOn)` Sets a new value for the attribute `activeOn`.
`void`	`setActiveUntil(Date activeUntil)` Sets a new value for the attribute `activeUntil`.
`void`	`setAuthor(String author)` Sets a new value for the attribute `author`.
`void`	`setCmsClass(String cmsClass)` Sets a new value for the attribute `cmsClass`.
`void`	`setCmsDefaultLanguage(String cmsDefaultLanguage)` Sets a new value for the attribute `cmsDefaultLanguage`.
`void`	`setCmsLanguage(String cmsLanguage)` Sets a new value for the attribute `cmsLanguage`.
`void`	`setCmsMeta(String cmsMeta)` Sets a new value for the attribute `cmsMeta`.
`void`	`setCmsTemplate(String cmsTemplate)` Sets a new value for the attribute `cmsTemplate`.
`void`	`setCmsTranslation(Integer cmsTranslation)` Sets a new value for the attribute `cmsTranslation`.
`void`	`setContentLanguage(short... contentLanguage)` Clears `contentLanguage` and adds the given value(s).
`void`	`setContentLength(Integer contentLength)` Sets a new value for the attribute `contentLength`.
`void`	`setContentType(String contentType)` Sets a new value for the attribute `contentType`.
`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`	`setDocumentAbstract(String documentAbstract)` Sets a new value for the attribute `documentAbstract`.
`void`	`setDocumentNumber(String documentNumber)` Sets a new value for the attribute `documentNumber`.
`void`	`setDocumentState(short documentState)` Sets a new value for the attribute `documentState`.
`void`	`setDocumentType(short documentType)` Sets a new value for the attribute `documentType`.
`void`	`setHeadRevision(DocumentRevision headRevision)` Sets a new value for the reference `headRevision`.
`void`	`setKeywords(String keywords)` Sets a new value for the attribute `keywords`.
`void`	`setLiteratureType(short literatureType)` Sets a new value for the attribute `literatureType`.
`void`	`setLocation(String location)` Sets a new value for the attribute `location`.
`void`	`setName(String name)` Sets a new value for the attribute `name`.
`void`	`setParent(Document parent)` Sets a new value for the reference `parent`.
`void`	`setQualifiedName(String qualifiedName)` Sets a new value for the attribute `qualifiedName`.
`void`	`setSearchText(String searchText)` Sets a new value for the attribute `searchText`.
`void`	`setTitle(String title)` Sets a new value for the attribute `title`.

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

Methods inherited from interface org.opencrx.kernel.base.cci2.Exporter
exportItem, exportItemAdvanced

Methods inherited from interface org.opencrx.kernel.base.cci2.Importer
importItem

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
  - getActiveOn
```
Date getActiveOn()
```
    Retrieves the possibly null value for the optional attribute activeOn.
    
    Returns:
    The possibly null value for attribute activeOn.
  - setActiveOn
```
void setActiveOn(Date activeOn)
```
    Sets a new value for the attribute activeOn.
    
    Parameters:
    activeOn - The possibly null new value for attribute activeOn.
  - getActiveUntil
```
Date getActiveUntil()
```
    Retrieves the possibly null value for the optional attribute activeUntil.
    
    Returns:
    The possibly null value for attribute activeUntil.
  - setActiveUntil
```
void setActiveUntil(Date activeUntil)
```
    Sets a new value for the attribute activeUntil.
    
    Parameters:
    activeUntil - The possibly null new value for attribute activeUntil.
  - getAttachment
```
<T extends DocumentAttachment> DocumentHasAttachment.Attachment<T> getAttachment()
```
    Retrieves a set containing all the elements for the reference attachment.
    
    Returns:
    A set containing all the elements for this reference.
  - getAuthor
```
String getAuthor()
```
    Retrieves the possibly null value for the optional attribute author.
    
    Returns:
    The possibly null value for attribute author.
  - setAuthor
```
void setAuthor(String author)
```
    Sets a new value for the attribute author.
    
    Parameters:
    author - The possibly null new value for attribute author.
  - getCmsClass
```
String getCmsClass()
```
    Retrieves the possibly null value for the optional attribute cmsClass.
    
    Returns:
    The possibly null value for attribute cmsClass.
  - setCmsClass
```
void setCmsClass(String cmsClass)
```
    Sets a new value for the attribute cmsClass.
    
    Parameters:
    cmsClass - The possibly null new value for attribute cmsClass.
  - getCmsDefaultLanguage
```
String getCmsDefaultLanguage()
```
    Retrieves the possibly null value for the optional attribute cmsDefaultLanguage.
    
    Returns:
    The possibly null value for attribute cmsDefaultLanguage.
  - setCmsDefaultLanguage
```
void setCmsDefaultLanguage(String cmsDefaultLanguage)
```
    Sets a new value for the attribute cmsDefaultLanguage.
    
    Parameters:
    cmsDefaultLanguage - The possibly null new value for attribute cmsDefaultLanguage.
  - getCmsLanguage
```
String getCmsLanguage()
```
    Retrieves the possibly null value for the optional attribute cmsLanguage.
    
    Returns:
    The possibly null value for attribute cmsLanguage.
  - setCmsLanguage
```
void setCmsLanguage(String cmsLanguage)
```
    Sets a new value for the attribute cmsLanguage.
    
    Parameters:
    cmsLanguage - The possibly null new value for attribute cmsLanguage.
  - getCmsMeta
```
String getCmsMeta()
```
    Retrieves the possibly null value for the optional attribute cmsMeta.
    
    Returns:
    The possibly null value for attribute cmsMeta.
  - setCmsMeta
```
void setCmsMeta(String cmsMeta)
```
    Sets a new value for the attribute cmsMeta.
    
    Parameters:
    cmsMeta - The possibly null new value for attribute cmsMeta.
  - getCmsTemplate
```
String getCmsTemplate()
```
    Retrieves the possibly null value for the optional attribute cmsTemplate.
    
    Returns:
    The possibly null value for attribute cmsTemplate.
  - setCmsTemplate
```
void setCmsTemplate(String cmsTemplate)
```
    Sets a new value for the attribute cmsTemplate.
    
    Parameters:
    cmsTemplate - The possibly null new value for attribute cmsTemplate.
  - getCmsTranslation
```
Integer getCmsTranslation()
```
    Retrieves the possibly null value for the optional attribute cmsTranslation.
    
    Returns:
    The possibly null value for attribute cmsTranslation.
  - setCmsTranslation
```
void setCmsTranslation(Integer cmsTranslation)
```
    Sets a new value for the attribute cmsTranslation.
    
    Parameters:
    cmsTranslation - The possibly null new value for attribute cmsTranslation.
  - getContentLanguage
```
List<Short> getContentLanguage()
```
    Retrieves a list containing all the elements for the attribute contentLanguage.
    
    Returns:
    A list containing all elements for this attribute.
  - setContentLanguage
```
void setContentLanguage(short... contentLanguage)
```
    Clears contentLanguage and adds the given value(s).
    This method is equivalent to
```
   list.clear();
   for(short e : attributeName){
     list.add(e);
   }
 
```
    Parameters:
    contentLanguage - value(s) to be added to contentLanguage
  - getContentLength
```
Integer getContentLength()
```
    Retrieves the possibly null value for the optional attribute contentLength.
    
    Returns:
    The possibly null value for attribute contentLength.
  - setContentLength
```
void setContentLength(Integer contentLength)
```
    Sets a new value for the attribute contentLength.
    
    Parameters:
    contentLength - The possibly null new value for attribute contentLength.
  - getContentType
```
String getContentType()
```
    Retrieves the possibly null value for the optional attribute contentType.
    
    Returns:
    The possibly null value for attribute contentType.
  - setContentType
```
void setContentType(String contentType)
```
    Sets a new value for the attribute contentType.
    
    Parameters:
    contentType - The possibly null new value for attribute contentType.
  - 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.
  - getDocumentAbstract
```
String getDocumentAbstract()
```
    Retrieves the possibly null value for the optional attribute documentAbstract.
    
    Returns:
    The possibly null value for attribute documentAbstract.
  - setDocumentAbstract
```
void setDocumentAbstract(String documentAbstract)
```
    Sets a new value for the attribute documentAbstract.
    
    Parameters:
    documentAbstract - The possibly null new value for attribute documentAbstract.
  - getDocumentFolderAssignment
```
<T extends FolderAssignment> DocumentHasDocumentFolderAssignment.DocumentFolderAssignment<T> getDocumentFolderAssignment()
```
    Retrieves a set containing all the elements for the reference documentFolderAssignment.
    
    Returns:
    A set containing all the elements for this reference.
  - getDocumentNumber
```
String getDocumentNumber()
```
    Retrieves the possibly null value for the optional attribute documentNumber.
    
    Returns:
    The possibly null value for attribute documentNumber.
  - setDocumentNumber
```
void setDocumentNumber(String documentNumber)
```
    Sets a new value for the attribute documentNumber.
    
    Parameters:
    documentNumber - The possibly null new value for attribute documentNumber.
  - getDocumentReference
```
<T extends DocumentReference> DocumentHasDocumentReference.DocumentReference<T> getDocumentReference()
```
    Retrieves a set containing all the elements for the reference documentReference.
    
    Returns:
    A set containing all the elements for this reference.
  - getDocumentState
```
short getDocumentState()
```
    Retrieves the value for the attribute documentState.
    DS_ACTIVE 0 The account is active. DS_INACTIVE 1 The account is inactive.
    
    Returns:
    The non-null value for attribute documentState.
  - setDocumentState
```
void setDocumentState(short documentState)
```
    Sets a new value for the attribute documentState.
    DS_ACTIVE 0 The account is active. DS_INACTIVE 1 The account is inactive.
    
    Parameters:
    documentState - The non-null new value for attribute documentState.
  - getDocumentType
```
short getDocumentType()
```
    Retrieves the value for the attribute documentType.
    0 - EMail 1 - CompanyInfo 2 - ProductInfo 3 - News
    
    Returns:
    The non-null value for attribute documentType.
  - setDocumentType
```
void setDocumentType(short documentType)
```
    Sets a new value for the attribute documentType.
    0 - EMail 1 - CompanyInfo 2 - ProductInfo 3 - News
    
    Parameters:
    documentType - The non-null new value for attribute documentType.
  - getFolder
```
<T extends DocumentFolder> List<T> getFolder()
```
    Retrieves the Collection of objects referenced by folder.
    
    Returns:
    The Collection of referenced objects.
  - getHeadRevision
```
DocumentRevision getHeadRevision()
```
    Retrieves the value for the reference headRevision.
    
    Returns:
    The – possibly null – value for this reference.
  - setHeadRevision
```
void setHeadRevision(DocumentRevision headRevision)
```
    Sets a new value for the reference headRevision.
    
    Parameters:
    headRevision - The new – possibly null – value for this reference.
  - getKeywords
```
String getKeywords()
```
    Retrieves the possibly null value for the optional attribute keywords.
    
    Returns:
    The possibly null value for attribute keywords.
  - setKeywords
```
void setKeywords(String keywords)
```
    Sets a new value for the attribute keywords.
    
    Parameters:
    keywords - The possibly null new value for attribute keywords.
  - getLink
```
<T extends DocumentLink> DocumentContainsLink.Link<T> getLink()
```
    Retrieves a set containing all the elements for the reference link.
    
    Returns:
    A set containing all the elements for this reference.
  - getLiteratureType
```
short getLiteratureType()
```
    Retrieves the value for the attribute literatureType.
    
    Returns:
    The non-null value for attribute literatureType.
  - setLiteratureType
```
void setLiteratureType(short literatureType)
```
    Sets a new value for the attribute literatureType.
    
    Parameters:
    literatureType - The non-null new value for attribute literatureType.
  - getLocation
```
String getLocation()
```
    Retrieves the possibly null value for the optional attribute location.
    
    Returns:
    The possibly null value for attribute location.
  - setLocation
```
void setLocation(String location)
```
    Sets a new value for the attribute location.
    
    Parameters:
    location - The possibly null new value for attribute location.
  - getLock
```
<T extends DocumentLock> DocumentHasLocks.Lock<T> getLock()
```
    Retrieves a set containing all the elements for the reference lock.
    
    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
```
Document getParent()
```
    Retrieves the value for the reference parent.
    
    Returns:
    The – possibly null – value for this reference.
  - setParent
```
void setParent(Document parent)
```
    Sets a new value for the reference parent.
    
    Parameters:
    parent - The new – possibly null – value for this reference.
  - getQualifiedName
```
String getQualifiedName()
```
    Retrieves the possibly null value for the optional attribute qualifiedName.
    
    Returns:
    The possibly null value for attribute qualifiedName.
  - setQualifiedName
```
void setQualifiedName(String qualifiedName)
```
    Sets a new value for the attribute qualifiedName.
    
    Parameters:
    qualifiedName - The possibly null new value for attribute qualifiedName.
  - getRevision
```
<T extends DocumentRevision> DocumentHasRevision.Revision<T> getRevision()
```
    Retrieves a set containing all the elements for the reference revision.
    
    Returns:
    A set containing all the elements for this reference.
  - getSearchText
```
String getSearchText()
```
    Retrieves the possibly null value for the optional attribute searchText.
    
    Returns:
    The possibly null value for attribute searchText.
  - setSearchText
```
void setSearchText(String searchText)
```
    Sets a new value for the attribute searchText.
    
    Parameters:
    searchText - The possibly null new value for attribute searchText.
  - getTitle
```
String getTitle()
```
    Retrieves the possibly null value for the optional attribute title.
    
    Returns:
    The possibly null value for attribute title.
  - setTitle
```
void setTitle(String title)
```
    Sets a new value for the attribute title.
    
    Parameters:
    title - The possibly null new value for attribute title.

Interface Document

Nested Class Summary

Method Summary

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

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

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

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

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

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

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

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

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

Method Detail

getActiveOn

setActiveOn

getActiveUntil

setActiveUntil

getAttachment

getAuthor

setAuthor

getCmsClass

setCmsClass

getCmsDefaultLanguage

setCmsDefaultLanguage

getCmsLanguage

setCmsLanguage

getCmsMeta

setCmsMeta

getCmsTemplate

setCmsTemplate

getCmsTranslation

setCmsTranslation

getContentLanguage

setContentLanguage

getContentLength

setContentLength

getContentType

setContentType

getDescription

setDescription

isDisabled

setDisabled

getDocumentAbstract

setDocumentAbstract

getDocumentFolderAssignment

getDocumentNumber

setDocumentNumber

getDocumentReference

getDocumentState

setDocumentState

getDocumentType

setDocumentType

getFolder

getHeadRevision

setHeadRevision

getKeywords

setKeywords

getLink

getLiteratureType

setLiteratureType

getLocation

setLocation

getLock

getName

setName

getParent

setParent

getQualifiedName

setQualifiedName

getRevision

getSearchText

setSearchText

getTitle

setTitle