public interface Document extends Auditee, Exporter, Importer, Indexed, SecureObject, UserDefined, PropertySetHolder, org.openmdx.base.cci2.BasicObject
Document
Modifier and Type | Interface and Description |
---|---|
static interface |
Document.Identity
Object Identity
|
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> |
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> |
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> |
getDocumentReference()
Retrieves a set containing all the elements for the reference
documentReference . |
DocumentSchema |
getDocumentSchema()
Retrieves the value for the reference
documentSchema . |
short |
getDocumentState()
Retrieves the value for the attribute
documentState . |
short |
getDocumentType()
Retrieves the value for the attribute
documentType . |
<T extends DocumentFolder> |
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> |
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> |
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> |
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 |
setDocumentSchema(DocumentSchema documentSchema)
Sets a new value for the reference
documentSchema . |
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 . |
ValidateSchemaResult |
validateSchema() |
exportItem
importItem
getIndexEntry, updateIndex
addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser, setOwningUser
getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4
getPropertySet
Date getActiveOn()
activeOn
.activeOn
.void setActiveOn(Date activeOn)
activeOn
.activeOn
- The possibly null new value for attribute activeOn
.Date getActiveUntil()
activeUntil
.activeUntil
.void setActiveUntil(Date activeUntil)
activeUntil
.activeUntil
- The possibly null new value for attribute activeUntil
.<T extends DocumentAttachment> DocumentHasAttachment.Attachment<T> getAttachment()
attachment
.String getAuthor()
author
.author
.void setAuthor(String author)
author
.author
- The possibly null new value for attribute author
.String getCmsClass()
cmsClass
.cmsClass
.void setCmsClass(String cmsClass)
cmsClass
.cmsClass
- The possibly null new value for attribute cmsClass
.String getCmsDefaultLanguage()
cmsDefaultLanguage
.cmsDefaultLanguage
.void setCmsDefaultLanguage(String cmsDefaultLanguage)
cmsDefaultLanguage
.cmsDefaultLanguage
- The possibly null new value for attribute cmsDefaultLanguage
.String getCmsLanguage()
cmsLanguage
.cmsLanguage
.void setCmsLanguage(String cmsLanguage)
cmsLanguage
.cmsLanguage
- The possibly null new value for attribute cmsLanguage
.String getCmsMeta()
cmsMeta
.cmsMeta
.void setCmsMeta(String cmsMeta)
cmsMeta
.cmsMeta
- The possibly null new value for attribute cmsMeta
.String getCmsTemplate()
cmsTemplate
.cmsTemplate
.void setCmsTemplate(String cmsTemplate)
cmsTemplate
.cmsTemplate
- The possibly null new value for attribute cmsTemplate
.Integer getCmsTranslation()
cmsTranslation
.cmsTranslation
.void setCmsTranslation(Integer cmsTranslation)
cmsTranslation
.cmsTranslation
- The possibly null new value for attribute cmsTranslation
.List<Short> getContentLanguage()
contentLanguage
.void setContentLanguage(short... contentLanguage)
contentLanguage
and adds the given value(s).
This method is equivalent to
list.clear(); for(short e : attributeName){ list.add(e); }
contentLanguage
- value(s) to be added to contentLanguage
Integer getContentLength()
contentLength
.contentLength
.void setContentLength(Integer contentLength)
contentLength
.contentLength
- The possibly null new value for attribute contentLength
.String getContentType()
contentType
.contentType
.void setContentType(String contentType)
contentType
.contentType
- The possibly null new value for attribute contentType
.String getDescription()
description
.description
.void setDescription(String description)
description
.description
- The possibly null new value for attribute description
.Boolean isDisabled()
disabled
.disabled
.void setDisabled(Boolean disabled)
disabled
.disabled
- The possibly null new value for attribute disabled
.String getDocumentAbstract()
documentAbstract
.documentAbstract
.void setDocumentAbstract(String documentAbstract)
documentAbstract
.documentAbstract
- The possibly null new value for attribute documentAbstract
.<T extends FolderAssignment> DocumentHasDocumentFolderAssignment.DocumentFolderAssignment<T> getDocumentFolderAssignment()
documentFolderAssignment
.String getDocumentNumber()
documentNumber
.documentNumber
.void setDocumentNumber(String documentNumber)
documentNumber
.documentNumber
- The possibly null new value for attribute documentNumber
.<T extends DocumentReference> DocumentHasDocumentReference.DocumentReference<T> getDocumentReference()
documentReference
.DocumentSchema getDocumentSchema()
documentSchema
.null
– value for this reference.void setDocumentSchema(DocumentSchema documentSchema)
documentSchema
.documentSchema
- The new – possibly null
– value for this reference.short getDocumentState()
documentState
.
DS_ACTIVE 0 The account is active. DS_INACTIVE 1 The account is inactive.
documentState
.void setDocumentState(short documentState)
documentState
.
DS_ACTIVE 0 The account is active. DS_INACTIVE 1 The account is inactive.
documentState
- The non-null new value for attribute documentState
.short getDocumentType()
documentType
.
0 - EMail 1 - CompanyInfo 2 - ProductInfo 3 - News
documentType
.void setDocumentType(short documentType)
documentType
.
0 - EMail 1 - CompanyInfo 2 - ProductInfo 3 - News
documentType
- The non-null new value for attribute documentType
.<T extends DocumentFolder> List<T> getFolder()
Collection
of objects referenced by folder
.Collection
of referenced objects.DocumentRevision getHeadRevision()
headRevision
.null
– value for this reference.void setHeadRevision(DocumentRevision headRevision)
headRevision
.headRevision
- The new – possibly null
– value for this reference.String getKeywords()
keywords
.keywords
.void setKeywords(String keywords)
keywords
.keywords
- The possibly null new value for attribute keywords
.<T extends DocumentLink> DocumentContainsLink.Link<T> getLink()
link
.short getLiteratureType()
literatureType
.literatureType
.void setLiteratureType(short literatureType)
literatureType
.literatureType
- The non-null new value for attribute literatureType
.String getLocation()
location
.location
.void setLocation(String location)
location
.location
- The possibly null new value for attribute location
.<T extends DocumentLock> DocumentHasLocks.Lock<T> getLock()
lock
.String getName()
name
.name
.void setName(String name)
name
.name
- The non-null new value for attribute name
.Document getParent()
parent
.null
– value for this reference.void setParent(Document parent)
parent
.parent
- The new – possibly null
– value for this reference.String getQualifiedName()
qualifiedName
.qualifiedName
.void setQualifiedName(String qualifiedName)
qualifiedName
.qualifiedName
- The possibly null new value for attribute qualifiedName
.<T extends DocumentRevision> DocumentHasRevision.Revision<T> getRevision()
revision
.String getSearchText()
searchText
.searchText
.void setSearchText(String searchText)
searchText
.searchText
- The possibly null new value for attribute searchText
.String getTitle()
title
.title
.void setTitle(String title)
title
.title
- The possibly null new value for attribute title
.ValidateSchemaResult validateSchema()
This software is published under the BSD license. Copyright © 2003-${build.year}, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.