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

Date	getActiveOn()
Date	getActiveUntil()
String	getAuthor()
short	getContentLanguage() Retrieves the value for the attribute contentLanguage.
Integer	getContentLength()
String	getContentType()
String	getDocumentAbstract()
String	getDocumentNumber()
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()
short	getLiteratureType() Retrieves the value for the attribute literatureType.
String	getLocation()
<T extends DocumentRevision> Collection<T>	getRevision() Retrieves a set containing all the elements for the reference revision.
String	getSearchText()
String	getTitle()
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	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	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	setSearchText(String searchText) Sets a new value for the attribute searchText.
void	setSegment(Segment segment) Sets a new value for the reference segment.
void	setSegment(Segment segment, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:document1:SegmentContainsDocument.
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.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, 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

Method Detail

getActiveOn

Date getActiveOn()

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()

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.

getAuthor

String getAuthor()

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.

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()

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()

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.

getDocumentAbstract

String getDocumentAbstract()

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()

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()

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.

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()

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.

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.

getSearchText

String getSearchText()

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()

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.

setSegment

void setSegment(Segment segment)

Sets a new value for the reference segment.

Parameters:

segment - The non-null new value for this reference.

setSegment

void setSegment(Segment segment,
                boolean idIsPersistent,
                String id)

Set the object's composite association org:opencrx:kernel:document1:SegmentContainsDocument.

Parameters:

segment - The non-null new value for this object's composite owner.

idIsPersistent - Defines whether the id is persistent.

id - The non-null new value for this object's qualifier.