org.opencrx.kernel.document1.cci2
Interface Document

All Superinterfaces:

Auditee, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, SecureObject, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter

All Known Subinterfaces:

Document

All Known Implementing Classes:

Document

public interface Document
extends Auditee, Importer, Indexed, SecureObject, XmlExporter, org.openmdx.base.cci2.BasicObject

Class Document

Nested Class Summary

static interface

Document.Identity Object Identity

Method Summary

void	addAttachment(boolean idIsPersistent, String id, DocumentAttachment attachment) Adds the specified element to the set of the values for the reference attachment.
void	addLink(boolean idIsPersistent, String id, DocumentLink link) Adds the specified element to the set of the values for the reference link.
void	addLock(boolean idIsPersistent, String id, DocumentLock lock) Adds the specified element to the set of the values for the reference lock.
void	addPropertySet(boolean idIsPersistent, String id, PropertySet propertySet) Adds the specified element to the set of the values for the reference propertySet.
void	addRevision(boolean idIsPersistent, String id, DocumentRevision revision) Adds the specified element to the set of the values for the reference revision.
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> Collection<T>	getAttachment() Retrieves a set containing all the elements for the reference attachment.
DocumentAttachment	getAttachment(boolean idIsPersistent, String id) Retrieves the value for the reference attachment for the specified qualifier attribute value.
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.
short	getContentLanguage() Retrieves the value 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.
String	getDocumentNumber() Retrieves the possibly null value for the optional attribute documentNumber.
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> Collection<T>	getLink() Retrieves a set containing all the elements for the reference link.
DocumentLink	getLink(boolean idIsPersistent, String id) Retrieves the value for the reference link for the specified qualifier attribute value.
short	getLiteratureType() Retrieves the value for the attribute literatureType.
String	getLocation() Retrieves the possibly null value for the optional attribute location.
<T extends DocumentLock> Collection<T>	getLock() Retrieves a set containing all the elements for the reference lock.
DocumentLock	getLock(boolean idIsPersistent, String id) Retrieves the value for the reference lock for the specified qualifier attribute value.
String	getName() Retrieves the value for the attribute name.
Document	getParent() Retrieves the value for the reference parent.
<T extends PropertySet> Collection<T>	getPropertySet() Retrieves a set containing all the elements for the reference propertySet.
PropertySet	getPropertySet(boolean idIsPersistent, String id) Retrieves the value for the reference propertySet for the specified qualifier attribute value.
String	getQualifiedName() Retrieves the possibly null value for the optional attribute qualifiedName.
<T extends DocumentRevision> Collection<T>	getRevision() Retrieves a set containing all the elements for the reference revision.
DocumentRevision	getRevision(boolean idIsPersistent, String id) Retrieves the value for the reference revision for the specified qualifier attribute value.
String	getSearchText() Retrieves the possibly null value for the optional attribute searchText.
String	getTitle() Retrieves the possibly null value for the optional attribute title.
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) Sets a new value for the attribute contentLanguage.
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	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, getAudit

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

importItem

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

getIndexEntry, getIndexEntry, updateIndex

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

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

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

exportXml

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

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> Collection<T> getAttachment()

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

Returns:

A set containing all the elements for this reference.

getAttachment

DocumentAttachment getAttachment(boolean idIsPersistent,
                                 String id)

Retrieves the value for the reference attachment for the specified qualifier attribute value.

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

addAttachment

void addAttachment(boolean idIsPersistent,
                   String id,
                   DocumentAttachment attachment)

Adds the specified element to the set of the values for the reference attachment.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

attachment - The element to be appended.

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

short getContentLanguage()

Retrieves the value for the attribute contentLanguage.

Returns:

The non-null value for attribute contentLanguage.

setContentLanguage

void setContentLanguage(short contentLanguage)

Sets a new value for the attribute contentLanguage.

Parameters:

contentLanguage - The non-null new value for attribute 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.

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.

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.

getDocumentState

short getDocumentState()

Retrieves the value for the attribute documentState.

Returns:

The non-null value for attribute documentState.

setDocumentState

void setDocumentState(short documentState)

Sets a new value for the attribute documentState.

Parameters:

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

getDocumentType

short getDocumentType()

Retrieves the value for the attribute documentType.

Returns:

The non-null value for attribute documentType.

setDocumentType

void setDocumentType(short documentType)

Sets a new value for the attribute documentType.

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 non-null new 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> Collection<T> getLink()

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

Returns:

A set containing all the elements for this reference.

getLink

DocumentLink getLink(boolean idIsPersistent,
                     String id)

Retrieves the value for the reference link for the specified qualifier attribute value.

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

addLink

void addLink(boolean idIsPersistent,
             String id,
             DocumentLink link)

Adds the specified element to the set of the values for the reference link.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

link - The element to be appended.

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> Collection<T> getLock()

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

Returns:

A set containing all the elements for this reference.

getLock

DocumentLock getLock(boolean idIsPersistent,
                     String id)

Retrieves the value for the reference lock for the specified qualifier attribute value.

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

addLock

void addLock(boolean idIsPersistent,
             String id,
             DocumentLock lock)

Adds the specified element to the set of the values for the reference lock.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

lock - The element to be appended.

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

getPropertySet

<T extends PropertySet> Collection<T> getPropertySet()

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

Returns:

A set containing all the elements for this reference.

getPropertySet

PropertySet getPropertySet(boolean idIsPersistent,
                           String id)

Retrieves the value for the reference propertySet for the specified qualifier attribute value.

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

addPropertySet

void addPropertySet(boolean idIsPersistent,
                    String id,
                    PropertySet propertySet)

Adds the specified element to the set of the values for the reference propertySet.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

propertySet - The element to be appended.

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> Collection<T> getRevision()

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

Returns:

A set containing all the elements for this reference.

getRevision

DocumentRevision getRevision(boolean idIsPersistent,
                             String id)

Retrieves the value for the reference revision for the specified qualifier attribute value.

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

addRevision

void addRevision(boolean idIsPersistent,
                 String id,
                 DocumentRevision revision)

Adds the specified element to the set of the values for the reference revision.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

revision - The element to be appended.

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.