org.opencrx.kernel.document1.cci
Interface Document

All Superinterfaces:

Auditee, BasicObject, ContextCapable, ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, ViewCapable, XmlExporter

All Known Implementing Classes:

DocumentImpl

public interface Document
extends Auditee, Importer, Indexed, SecureObject, XmlExporter, BasicObject

Method Summary

void	addFolder(DocumentFolder newValue)
void	addFolder(int index, DocumentFolder newValue)
void	addRevision(DocumentRevision newValue)
void	addRevision(String id, DocumentRevision newValue)
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.
Collection	getFolder() Retrieves the objects referenced by folder.
DocumentFolder	getFolder(int index) Retrieves the value for the reference folder for the specified qualifier attribute value.
DocumentRevision	getHeadRevision() Retrieves the value for the optional reference headRevision.
String	getKeywords()
short	getLiteratureType() Retrieves the value for the attribute literatureType.
String	getLocation()
Collection	getRevision() Retrieves a collection containing all the elements for the reference revision.
List	getRevision(DocumentRevisionFilter filter) Retrieves the value for the reference revision for the specified filter.
List	getRevision(DocumentRevisionQuery query) Retrieves the value for the reference revision for the specified query.
DocumentRevision	getRevision(String id) Retrieves the value for the reference revision for the specified qualifier attribute value.
String	getSearchText()
String	getTitle()
void	removeFolder(int index)
void	removeHeadRevision() Removes the value for the optional reference headRevision.
void	removeRevision(String id)
void	setActiveOn(Date newValue) Sets a new value for the attribute activeOn.
void	setActiveUntil(Date newValue) Sets a new value for the attribute activeUntil.
void	setAuthor(String newValue) Sets a new value for the attribute author.
void	setContentLanguage(short newValue) Sets a new value for the attribute contentLanguage.
void	setContentLength(Integer newValue) Sets a new value for the attribute contentLength.
void	setContentType(String newValue) Sets a new value for the attribute contentType.
void	setDocumentAbstract(String newValue) Sets a new value for the attribute documentAbstract.
void	setDocumentNumber(String newValue) Sets a new value for the attribute documentNumber.
void	setDocumentState(short newValue) Sets a new value for the attribute documentState.
void	setDocumentType(short newValue) Sets a new value for the attribute documentType.
void	setHeadRevision(DocumentRevision newValue) Sets a new value for the reference headRevision.
void	setKeywords(String newValue) Sets a new value for the attribute keywords.
void	setLiteratureType(short newValue) Sets a new value for the attribute literatureType.
void	setLocation(String newValue) Sets a new value for the attribute location.
void	setSearchText(String newValue) Sets a new value for the attribute searchText.
void	setTitle(String newValue) Sets a new value for the attribute title.

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

getAudit, getAudit, getAudit, getAudit

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

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

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

exportXml, exportXml

Methods inherited from interface org.openmdx.base.cci.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

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

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, getView

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

getActiveOn

Date getActiveOn()

Returns:

The possibly null value for attribute activeOn.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setActiveOn

void setActiveOn(Date newValue)

Sets a new value for the attribute activeOn.

Parameters:

newValue - The possibly null new value for attribute activeOn.

Throws:

JmiException - If the value cannot be set for some reason.

getActiveUntil

Date getActiveUntil()

Returns:

The possibly null value for attribute activeUntil.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setActiveUntil

void setActiveUntil(Date newValue)

Sets a new value for the attribute activeUntil.

Parameters:

newValue - The possibly null new value for attribute activeUntil.

Throws:

JmiException - If the value cannot be set for some reason.

getAuthor

String getAuthor()

Returns:

The possibly null value for attribute author.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setAuthor

void setAuthor(String newValue)

Sets a new value for the attribute author.

Parameters:

newValue - The possibly null new value for attribute author.

Throws:

JmiException - If the value cannot be set for some reason.

getContentLanguage

short getContentLanguage()

Retrieves the value for the attribute contentLanguage.

Returns:

The non-null value for attribute contentLanguage.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setContentLanguage

void setContentLanguage(short newValue)

Sets a new value for the attribute contentLanguage.

Parameters:

newValue - The non-null new value for attribute contentLanguage.

Throws:

JmiException - If the value cannot be set for some reason.

getContentLength

Integer getContentLength()

Returns:

The possibly null value for attribute contentLength.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setContentLength

void setContentLength(Integer newValue)

Sets a new value for the attribute contentLength.

Parameters:

newValue - The possibly null new value for attribute contentLength.

Throws:

JmiException - If the value cannot be set for some reason.

getContentType

String getContentType()

Returns:

The possibly null value for attribute contentType.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setContentType

void setContentType(String newValue)

Sets a new value for the attribute contentType.

Parameters:

newValue - The possibly null new value for attribute contentType.

Throws:

JmiException - If the value cannot be set for some reason.

getDocumentAbstract

String getDocumentAbstract()

Returns:

The possibly null value for attribute documentAbstract.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDocumentAbstract

void setDocumentAbstract(String newValue)

Sets a new value for the attribute documentAbstract.

Parameters:

newValue - The possibly null new value for attribute documentAbstract.

Throws:

JmiException - If the value cannot be set for some reason.

getDocumentNumber

String getDocumentNumber()

Returns:

The possibly null value for attribute documentNumber.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDocumentNumber

void setDocumentNumber(String newValue)

Sets a new value for the attribute documentNumber.

Parameters:

newValue - The possibly null new value for attribute documentNumber.

Throws:

JmiException - If the value cannot be set for some reason.

getDocumentState

short getDocumentState()

Retrieves the value for the attribute documentState.

Returns:

The non-null value for attribute documentState.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDocumentState

void setDocumentState(short newValue)

Sets a new value for the attribute documentState.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

getDocumentType

short getDocumentType()

Retrieves the value for the attribute documentType.

Returns:

The non-null value for attribute documentType.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDocumentType

void setDocumentType(short newValue)

Sets a new value for the attribute documentType.

Parameters:

newValue - The non-null new value for attribute documentType.

Throws:

JmiException - If the value cannot be set for some reason.

getFolder

DocumentFolder getFolder(int index)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFolder

Collection getFolder()

Retrieves the objects referenced by folder.

Returns:

The collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addFolder

void addFolder(int index,
               DocumentFolder newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addFolder

void addFolder(DocumentFolder newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeFolder

void removeFolder(int index)

Throws:

JmiException - If the value cannot be removed for some reason.

getHeadRevision

DocumentRevision getHeadRevision()

Retrieves the value for the optional reference headRevision.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setHeadRevision

void setHeadRevision(DocumentRevision newValue)

Sets a new value for the reference headRevision.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

removeHeadRevision

void removeHeadRevision()

Removes the value for the optional reference headRevision.

Throws:

JmiException - If the value cannot be removed for some reason.

getKeywords

String getKeywords()

Returns:

The possibly null value for attribute keywords.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setKeywords

void setKeywords(String newValue)

Sets a new value for the attribute keywords.

Parameters:

newValue - The possibly null new value for attribute keywords.

Throws:

JmiException - If the value cannot be set for some reason.

getLiteratureType

short getLiteratureType()

Retrieves the value for the attribute literatureType.

Returns:

The non-null value for attribute literatureType.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setLiteratureType

void setLiteratureType(short newValue)

Sets a new value for the attribute literatureType.

Parameters:

newValue - The non-null new value for attribute literatureType.

Throws:

JmiException - If the value cannot be set for some reason.

getLocation

String getLocation()

Returns:

The possibly null value for attribute location.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setLocation

void setLocation(String newValue)

Sets a new value for the attribute location.

Parameters:

newValue - The possibly null new value for attribute location.

Throws:

JmiException - If the value cannot be set for some reason.

getRevision

DocumentRevision getRevision(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getRevision

Collection getRevision()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getRevision

List getRevision(DocumentRevisionFilter filter)

Retrieves the value for the reference revision for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getRevision

List getRevision(DocumentRevisionQuery query)

Retrieves the value for the reference revision for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addRevision

void addRevision(String id,
                 DocumentRevision newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addRevision

void addRevision(DocumentRevision newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeRevision

void removeRevision(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getSearchText

String getSearchText()

Returns:

The possibly null value for attribute searchText.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setSearchText

void setSearchText(String newValue)

Sets a new value for the attribute searchText.

Parameters:

newValue - The possibly null new value for attribute searchText.

Throws:

JmiException - If the value cannot be set for some reason.

getTitle

String getTitle()

Returns:

The possibly null value for attribute title.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setTitle

void setTitle(String newValue)

Sets a new value for the attribute title.

Parameters:

newValue - The possibly null new value for attribute title.

Throws:

JmiException - If the value cannot be set for some reason.