org.opencrx.kernel.document1.jdo2
Class Document

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.opencrx.kernel.document1.jdo2.Document

All Implemented Interfaces:

Serializable, Auditee, Exporter, Importer, Indexed, SecureObject, Document, PropertySetHolder, BasicObject, ContextCapable, ExtentCapable, ViewCapable

public class Document
extends org.w3c.jdo2.AbstractObject
implements Document

Class Document

See Also:

Serialized Form

Nested Class Summary

static class	Document.Identity The object's application identity
static class	Document.Slice Slice object hold the Document's multivalued attributes

Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject

org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>

Field Summary

static List<String>	BASE_CLASS Define this class as base class
static List<String>	CLASS Define the model class org::opencrx::kernel::document1::Document

Constructor Summary

Document()

Method Summary

ModifySecureObjectResult	addOwningGroup(ModifyOwningGroupParams in)
void	addToSegment(Segment segment) Sets a new value for the reference segment.
void	addToSegment(Segment segment, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:document1:SegmentContainsDocument.
CheckPermissionsResult	checkPermissions(CheckPermissionsParams in)
ExportItemResult	exportItem(ExportItemParams in)
ExportItemResult	exportItemAdvanced(ExportItemAdvancedParams in)
ViewCapable	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
short	getAccessLevelBrowse() Retrieves the value for the attribute accessLevelBrowse.
short	getAccessLevelDelete() Retrieves the value for the attribute accessLevelDelete.
short	getAccessLevelUpdate() Retrieves the value for the attribute accessLevelUpdate.
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.
<T extends AuditEntry> AuditeeHasAuditEntries.Audit<T>	getAudit() Retrieves a set containing all the elements for the reference audit.
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.
<T extends Context> Map<String,T>	getContext() Retrieves the Collection of objects referenced by context.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
Set<String>	getCreatedBy() Retrieves a set containing all the elements for the attribute createdBy.
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.
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	getIdentity() Retrieves the value for the attribute identity.
<T extends IndexEntry> IndexedHasIndexEntry.IndexEntry<T>	getIndexEntry() Retrieves a set containing all the elements for the reference indexEntry.
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.
Date	getModifiedAt() Retrieves the value for the attribute modifiedAt.
Set<String>	getModifiedBy() Retrieves a set containing all the elements for the attribute modifiedBy.
String	getName() Retrieves the value for the attribute name.
List<String>	getOwner() Retrieves a list containing all the elements for the attribute owner.
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
User	getOwningUser() Retrieves the value for the reference owningUser.
Document	getParent() Retrieves the value for the reference parent.
<T extends PropertySet> DocumentContainsPropertySet.PropertySet<T>	getPropertySet() Retrieves a set containing all the elements for the reference propertySet.
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.
<T extends View> ObjectHasView.View<T>	getView() Retrieves a set containing all the elements for the reference view.
ImportResult	importItem(ImportParams in)
Boolean	isDisabled() Retrieves the possibly null value for the optional attribute disabled.
static Document.Identity	newIdentity(Segment.Identity segment, QualifierType idType, String id)
protected org.w3c.jdo2.AbstractObject.Slice	newSlice(int index)
protected List<String>	openmdxjdoGetClass() Retrieve the model class
protected String	openmdxjdoGetObjectId() Retrieve the object's JDO identity key
protected int	openmdxjdoGetSize(int field)
protected <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E>	openmdxjdoGetSlices()
protected void	openmdxjdoSetSize(int field, int size)
static Document.Identity	openmdxjdoToIdentity(ObjectId objectId)
ModifySecureObjectResult	removeAllOwningGroup(RemoveAllOwningGroupParams in)
ModifySecureObjectResult	removeOwningGroup(ModifyOwningGroupParams in)
ModifySecureObjectResult	replaceOwningGroup(ModifyOwningGroupsParams in)
ModifySecureObjectResult	setAccessLevel(SetAccessLevelParams in)
void	setAccessLevelBrowse(short accessLevelBrowse) Sets a new value for the attribute accessLevelBrowse.
void	setAccessLevelDelete(short accessLevelDelete) Sets a new value for the attribute accessLevelDelete.
void	setAccessLevelUpdate(short accessLevelUpdate) Sets a new value for the attribute accessLevelUpdate.
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	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.
ModifySecureObjectResult	setOwningUser(SetOwningUserParams in)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
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.
UpdateIndexResult	updateIndex()

Methods inherited from class org.w3c.jdo2.AbstractObject

openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewMap, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement

Methods inherited from class org.oasisopen.jdo2.Identifiable

jdoClass, modelClasses, openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS

public static final List<String> CLASS

Define the model class org::opencrx::kernel::document1::Document

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

Document.CLASS

Constructor Detail

Document

public Document()

Method Detail

openmdxjdoGetObjectId

protected String openmdxjdoGetObjectId()

Retrieve the object's JDO identity key

Specified by:

openmdxjdoGetObjectId in class org.oasisopen.jdo2.Identifiable

Returns:

the value of the object's JDO identity key

openmdxjdoGetSlices

protected final <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E> openmdxjdoGetSlices()

Overrides:

openmdxjdoGetSlices in class org.w3c.jdo2.AbstractObject

getAccessLevelDelete

public short getAccessLevelDelete()

Retrieves the value for the attribute accessLevelDelete.

Specified by:

getAccessLevelDelete in interface SecureObject

Returns:

The non-null value for attribute accessLevelDelete.

setAccessLevelDelete

public void setAccessLevelDelete(short accessLevelDelete)

Sets a new value for the attribute accessLevelDelete.

Specified by:

setAccessLevelDelete in interface SecureObject

Parameters:

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

getDocumentType

public short getDocumentType()

Retrieves the value for the attribute documentType.

0 - EMail 1 - CompanyInfo 2 - ProductInfo 3 - News

Specified by:

getDocumentType in interface Document

Returns:

The non-null value for attribute documentType.

setDocumentType

public void setDocumentType(short documentType)

Sets a new value for the attribute documentType.

0 - EMail 1 - CompanyInfo 2 - ProductInfo 3 - News

Specified by:

setDocumentType in interface Document

Parameters:

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

getLocation

public final String getLocation()

Retrieves the possibly null value for the optional attribute location.

Specified by:

getLocation in interface Document

Returns:

The possibly null value for attribute location.

setLocation

public void setLocation(String location)

Sets a new value for the attribute location.

Specified by:

setLocation in interface Document

Parameters:

location - The possibly null new value for attribute location.

getModifiedBy

public final Set<String> getModifiedBy()

Retrieves a set containing all the elements for the attribute modifiedBy.

Specified by:

getModifiedBy in interface BasicObject

Returns:

A set containing all elements for this attribute.

getCmsMeta

public final String getCmsMeta()

Retrieves the possibly null value for the optional attribute cmsMeta.

Specified by:

getCmsMeta in interface Document

Returns:

The possibly null value for attribute cmsMeta.

setCmsMeta

public void setCmsMeta(String cmsMeta)

Sets a new value for the attribute cmsMeta.

Specified by:

setCmsMeta in interface Document

Parameters:

cmsMeta - The possibly null new value for attribute cmsMeta.

getContentType

public final String getContentType()

Retrieves the possibly null value for the optional attribute contentType.

Specified by:

getContentType in interface Document

Returns:

The possibly null value for attribute contentType.

setContentType

public void setContentType(String contentType)

Sets a new value for the attribute contentType.

Specified by:

setContentType in interface Document

Parameters:

contentType - The possibly null new value for attribute contentType.

getAccessLevelBrowse

public short getAccessLevelBrowse()

Retrieves the value for the attribute accessLevelBrowse.

Specified by:

getAccessLevelBrowse in interface SecureObject

Returns:

The non-null value for attribute accessLevelBrowse.

setAccessLevelBrowse

public void setAccessLevelBrowse(short accessLevelBrowse)

Sets a new value for the attribute accessLevelBrowse.

Specified by:

setAccessLevelBrowse in interface SecureObject

Parameters:

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

getRevision

public <T extends DocumentRevision> DocumentHasRevision.Revision<T> getRevision()

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

Specified by:

getRevision in interface Document

Returns:

A set containing all the elements for this reference.

getDescription

public final String getDescription()

Retrieves the possibly null value for the optional attribute description.

Specified by:

getDescription in interface Document

Returns:

The possibly null value for attribute description.

setDescription

public void setDescription(String description)

Sets a new value for the attribute description.

Specified by:

setDescription in interface Document

Parameters:

description - The possibly null new value for attribute description.

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams in)

Specified by:

removeAllOwningGroup in interface SecureObject

getDocumentNumber

public final String getDocumentNumber()

Retrieves the possibly null value for the optional attribute documentNumber.

Specified by:

getDocumentNumber in interface Document

Returns:

The possibly null value for attribute documentNumber.

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Sets a new value for the attribute documentNumber.

Specified by:

setDocumentNumber in interface Document

Parameters:

documentNumber - The possibly null new value for attribute documentNumber.

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams in)

Specified by:

setOwningUser in interface SecureObject

getContentLength

public final Integer getContentLength()

Retrieves the possibly null value for the optional attribute contentLength.

Specified by:

getContentLength in interface Document

Returns:

The possibly null value for attribute contentLength.

setContentLength

public void setContentLength(Integer contentLength)

Sets a new value for the attribute contentLength.

Specified by:

setContentLength in interface Document

Parameters:

contentLength - The possibly null new value for attribute contentLength.

getOwningGroup

public <T extends PrincipalGroup> List<T> getOwningGroup()

Retrieves the Collection of objects referenced by owningGroup.

Specified by:

getOwningGroup in interface SecureObject

Returns:

The Collection of referenced objects.

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams in)

Specified by:

addOwningGroup in interface SecureObject

getActiveUntil

public final Date getActiveUntil()

Retrieves the possibly null value for the optional attribute activeUntil.

Specified by:

getActiveUntil in interface Document

Returns:

The possibly null value for attribute activeUntil.

setActiveUntil

public void setActiveUntil(Date activeUntil)

Sets a new value for the attribute activeUntil.

Specified by:

setActiveUntil in interface Document

Parameters:

activeUntil - The possibly null new value for attribute activeUntil.

getKeywords

public final String getKeywords()

Retrieves the possibly null value for the optional attribute keywords.

Specified by:

getKeywords in interface Document

Returns:

The possibly null value for attribute keywords.

setKeywords

public void setKeywords(String keywords)

Sets a new value for the attribute keywords.

Specified by:

setKeywords in interface Document

Parameters:

keywords - The possibly null new value for attribute keywords.

getParent

public Document getParent()

Retrieves the value for the reference parent.

Specified by:

getParent in interface Document

Returns:

The – possibly null – value for this reference.

setParent

public void setParent(Document parent)

Sets a new value for the reference parent.

Specified by:

setParent in interface Document

Parameters:

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

importItem

public ImportResult importItem(ImportParams in)

Specified by:

importItem in interface Importer

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)

Specified by:

removeOwningGroup in interface SecureObject

getDocumentAbstract

public final String getDocumentAbstract()

Retrieves the possibly null value for the optional attribute documentAbstract.

Specified by:

getDocumentAbstract in interface Document

Returns:

The possibly null value for attribute documentAbstract.

setDocumentAbstract

public void setDocumentAbstract(String documentAbstract)

Sets a new value for the attribute documentAbstract.

Specified by:

setDocumentAbstract in interface Document

Parameters:

documentAbstract - The possibly null new value for attribute documentAbstract.

getCmsDefaultLanguage

public final String getCmsDefaultLanguage()

Retrieves the possibly null value for the optional attribute cmsDefaultLanguage.

Specified by:

getCmsDefaultLanguage in interface Document

Returns:

The possibly null value for attribute cmsDefaultLanguage.

setCmsDefaultLanguage

public void setCmsDefaultLanguage(String cmsDefaultLanguage)

Sets a new value for the attribute cmsDefaultLanguage.

Specified by:

setCmsDefaultLanguage in interface Document

Parameters:

cmsDefaultLanguage - The possibly null new value for attribute cmsDefaultLanguage.

getCmsTemplate

public final String getCmsTemplate()

Retrieves the possibly null value for the optional attribute cmsTemplate.

Specified by:

getCmsTemplate in interface Document

Returns:

The possibly null value for attribute cmsTemplate.

setCmsTemplate

public void setCmsTemplate(String cmsTemplate)

Sets a new value for the attribute cmsTemplate.

Specified by:

setCmsTemplate in interface Document

Parameters:

cmsTemplate - The possibly null new value for attribute cmsTemplate.

getCreatedBy

public final Set<String> getCreatedBy()

Retrieves a set containing all the elements for the attribute createdBy.

Specified by:

getCreatedBy in interface BasicObject

Returns:

A set containing all elements for this attribute.

getAccessGrantedByParent

public ViewCapable getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams in)

Specified by:

setAccessLevel in interface SecureObject

getOwner

public final List<String> getOwner()

Retrieves a list containing all the elements for the attribute owner.

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

replaceOwningGroup

public ModifySecureObjectResult replaceOwningGroup(ModifyOwningGroupsParams in)

Specified by:

replaceOwningGroup in interface SecureObject

getIndexEntry

public <T extends IndexEntry> IndexedHasIndexEntry.IndexEntry<T> getIndexEntry()

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

Specified by:

getIndexEntry in interface Indexed

Returns:

A set containing all the elements for this reference.

getSearchText

public final String getSearchText()

Retrieves the possibly null value for the optional attribute searchText.

Specified by:

getSearchText in interface Document

Returns:

The possibly null value for attribute searchText.

setSearchText

public void setSearchText(String searchText)

Sets a new value for the attribute searchText.

Specified by:

setSearchText in interface Document

Parameters:

searchText - The possibly null new value for attribute searchText.

getView

public <T extends View> ObjectHasView.View<T> getView()

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

Specified by:

getView in interface ViewCapable

Returns:

A set containing all the elements for this reference.

getOwningUser

public User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

public void setOwningUser(User owningUser)

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

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

getModifiedAt

public Date getModifiedAt()

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface BasicObject

Returns:

The non-null value for attribute modifiedAt.

getActiveOn

public final Date getActiveOn()

Retrieves the possibly null value for the optional attribute activeOn.

Specified by:

getActiveOn in interface Document

Returns:

The possibly null value for attribute activeOn.

setActiveOn

public void setActiveOn(Date activeOn)

Sets a new value for the attribute activeOn.

Specified by:

setActiveOn in interface Document

Parameters:

activeOn - The possibly null new value for attribute activeOn.

getLink

public <T extends DocumentLink> DocumentContainsLink.Link<T> getLink()

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

Specified by:

getLink in interface Document

Returns:

A set containing all the elements for this reference.

getPropertySet

public <T extends PropertySet> DocumentContainsPropertySet.PropertySet<T> getPropertySet()

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

Specified by:

getPropertySet in interface PropertySetHolder

Returns:

A set containing all the elements for this reference.

getAuthor

public final String getAuthor()

Retrieves the possibly null value for the optional attribute author.

Specified by:

getAuthor in interface Document

Returns:

The possibly null value for attribute author.

setAuthor

public void setAuthor(String author)

Sets a new value for the attribute author.

Specified by:

setAuthor in interface Document

Parameters:

author - The possibly null new value for attribute author.

getIdentity

public String getIdentity()

Retrieves the value for the attribute identity.

Specified by:

getIdentity in interface ExtentCapable

Returns:

The non-null value for attribute identity.

getTitle

public final String getTitle()

Retrieves the possibly null value for the optional attribute title.

Specified by:

getTitle in interface Document

Returns:

The possibly null value for attribute title.

setTitle

public void setTitle(String title)

Sets a new value for the attribute title.

Specified by:

setTitle in interface Document

Parameters:

title - The possibly null new value for attribute title.

getLiteratureType

public short getLiteratureType()

Retrieves the value for the attribute literatureType.

Specified by:

getLiteratureType in interface Document

Returns:

The non-null value for attribute literatureType.

setLiteratureType

public void setLiteratureType(short literatureType)

Sets a new value for the attribute literatureType.

Specified by:

setLiteratureType in interface Document

Parameters:

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

getCreatedAt

public Date getCreatedAt()

Retrieves the value for the attribute createdAt.

Specified by:

getCreatedAt in interface BasicObject

Returns:

The non-null value for attribute createdAt.

getName

public String getName()

Retrieves the value for the attribute name.

Specified by:

getName in interface Document

Returns:

The non-null value for attribute name.

setName

public void setName(String name)

Sets a new value for the attribute name.

Specified by:

setName in interface Document

Parameters:

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

getCmsLanguage

public final String getCmsLanguage()

Retrieves the possibly null value for the optional attribute cmsLanguage.

Specified by:

getCmsLanguage in interface Document

Returns:

The possibly null value for attribute cmsLanguage.

setCmsLanguage

public void setCmsLanguage(String cmsLanguage)

Sets a new value for the attribute cmsLanguage.

Specified by:

setCmsLanguage in interface Document

Parameters:

cmsLanguage - The possibly null new value for attribute cmsLanguage.

getCmsClass

public final String getCmsClass()

Retrieves the possibly null value for the optional attribute cmsClass.

Specified by:

getCmsClass in interface Document

Returns:

The possibly null value for attribute cmsClass.

setCmsClass

public void setCmsClass(String cmsClass)

Sets a new value for the attribute cmsClass.

Specified by:

setCmsClass in interface Document

Parameters:

cmsClass - The possibly null new value for attribute cmsClass.

exportItemAdvanced

public ExportItemResult exportItemAdvanced(ExportItemAdvancedParams in)

Specified by:

exportItemAdvanced in interface Exporter

getDocumentState

public short getDocumentState()

Retrieves the value for the attribute documentState.

DS_ACTIVE 0 The account is active. DS_INACTIVE 1 The account is inactive.

Specified by:

getDocumentState in interface Document

Returns:

The non-null value for attribute documentState.

setDocumentState

public 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.

Specified by:

setDocumentState in interface Document

Parameters:

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

getContentLanguage

public short getContentLanguage()

Retrieves the value for the attribute contentLanguage.

Specified by:

getContentLanguage in interface Document

Returns:

The non-null value for attribute contentLanguage.

setContentLanguage

public void setContentLanguage(short contentLanguage)

Sets a new value for the attribute contentLanguage.

Specified by:

setContentLanguage in interface Document

Parameters:

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

getQualifiedName

public final String getQualifiedName()

Retrieves the possibly null value for the optional attribute qualifiedName.

Specified by:

getQualifiedName in interface Document

Returns:

The possibly null value for attribute qualifiedName.

setQualifiedName

public void setQualifiedName(String qualifiedName)

Sets a new value for the attribute qualifiedName.

Specified by:

setQualifiedName in interface Document

Parameters:

qualifiedName - The possibly null new value for attribute qualifiedName.

getDocumentFolderAssignment

public <T extends FolderAssignment> DocumentHasDocumentFolderAssignment.DocumentFolderAssignment<T> getDocumentFolderAssignment()

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

Specified by:

getDocumentFolderAssignment in interface Document

Returns:

A set containing all the elements for this reference.

getLock

public <T extends DocumentLock> DocumentHasLocks.Lock<T> getLock()

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

Specified by:

getLock in interface Document

Returns:

A set containing all the elements for this reference.

getHeadRevision

public DocumentRevision getHeadRevision()

Retrieves the value for the reference headRevision.

Specified by:

getHeadRevision in interface Document

Returns:

The – possibly null – value for this reference.

setHeadRevision

public void setHeadRevision(DocumentRevision headRevision)

Sets a new value for the reference headRevision.

Specified by:

setHeadRevision in interface Document

Parameters:

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

getAudit

public <T extends AuditEntry> AuditeeHasAuditEntries.Audit<T> getAudit()

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

Specified by:

getAudit in interface Auditee

Returns:

A set containing all the elements for this reference.

checkPermissions

public CheckPermissionsResult checkPermissions(CheckPermissionsParams in)

Specified by:

checkPermissions in interface SecureObject

getAttachment

public <T extends DocumentAttachment> DocumentHasAttachment.Attachment<T> getAttachment()

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

Specified by:

getAttachment in interface Document

Returns:

A set containing all the elements for this reference.

getCmsTranslation

public final Integer getCmsTranslation()

Retrieves the possibly null value for the optional attribute cmsTranslation.

Specified by:

getCmsTranslation in interface Document

Returns:

The possibly null value for attribute cmsTranslation.

setCmsTranslation

public void setCmsTranslation(Integer cmsTranslation)

Sets a new value for the attribute cmsTranslation.

Specified by:

setCmsTranslation in interface Document

Parameters:

cmsTranslation - The possibly null new value for attribute cmsTranslation.

updateIndex

public UpdateIndexResult updateIndex()

Specified by:

updateIndex in interface Indexed

getFolder

public <T extends DocumentFolder> List<T> getFolder()

Retrieves the Collection of objects referenced by folder.

Specified by:

getFolder in interface Document

Returns:

The Collection of referenced objects.

getAccessLevelUpdate

public short getAccessLevelUpdate()

Retrieves the value for the attribute accessLevelUpdate.

Specified by:

getAccessLevelUpdate in interface SecureObject

Returns:

The non-null value for attribute accessLevelUpdate.

setAccessLevelUpdate

public void setAccessLevelUpdate(short accessLevelUpdate)

Sets a new value for the attribute accessLevelUpdate.

Specified by:

setAccessLevelUpdate in interface SecureObject

Parameters:

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

getContext

public <T extends Context> Map<String,T> getContext()

Retrieves the Collection of objects referenced by context.

Specified by:

getContext in interface ContextCapable

Returns:

The Collection of referenced objects.

isDisabled

public final Boolean isDisabled()

Retrieves the possibly null value for the optional attribute disabled.

Specified by:

isDisabled in interface Document

Returns:

The possibly null value for attribute disabled.

setDisabled

public void setDisabled(Boolean disabled)

Sets a new value for the attribute disabled.

Specified by:

setDisabled in interface Document

Parameters:

disabled - The possibly null new value for attribute disabled.

exportItem

public ExportItemResult exportItem(ExportItemParams in)

Specified by:

exportItem in interface Exporter

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class org.w3c.jdo2.AbstractObject

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class org.w3c.jdo2.AbstractObject

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()

Retrieve the model class

Returns:

the model class

See Also:

Document.CLASS

addToSegment

public void addToSegment(Segment segment)

Sets a new value for the reference segment.

Parameters:

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

addToSegment

public void addToSegment(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.

newIdentity

public static Document.Identity newIdentity(Segment.Identity segment,
                                            QualifierType idType,
                                            String id)

openmdxjdoToIdentity

public static Document.Identity openmdxjdoToIdentity(ObjectId objectId)