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, Importer, Indexed, SecureObject, XmlExporter, Document, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.compatibility.view1.cci2.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

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

org.w3c.jdo2.AbstractObject.BLOB, org.w3c.jdo2.AbstractObject.CLOB, 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

<T extends ModifySecureObjectResult> T	addOwningGroup(PrincipalGroup group, short mode)
<T extends ExportResult> T	exportXml(String attributeFilter, String referenceFilter)
org.openmdx.base.cci2.BasicObject	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()
Date	getActiveUntil()
<T extends AuditEntry> Collection<T>	getAudit() Retrieves a set containing all the elements for the reference audit.
String	getAuthor()
short	getContentLanguage() Retrieves the value for the attribute contentLanguage.
Integer	getContentLength()
String	getContentType()
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
Set<String>	getCreatedBy()
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.
XRI	getIdentity() Retrieves the value for the derived attribute identity.
<T extends IndexEntry> Collection<T>	getIndexEntry() Retrieves a set containing all the elements for the reference indexEntry.
String	getKeywords()
short	getLiteratureType() Retrieves the value for the attribute literatureType.
String	getLocation()
Date	getModifiedAt() Retrieves the value for the attribute modifiedAt.
Set<String>	getModifiedBy()
List<String>	getOwner()
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
User	getOwningUser() Retrieves the value for the reference owningUser.
<T extends DocumentRevision> Collection<T>	getRevision() Retrieves a set containing all the elements for the reference revision.
String	getSearchText()
String	getTitle()
<T extends org.openmdx.compatibility.view1.cci2.View> Collection<T>	getView() Retrieves a set containing all the elements for the reference view.
<T extends ImportResult> T	importItem(byte[] item, String itemMimeType, String itemName, short locale)
static Document.Identity	newIdentity(org.openmdx.base.cci2.Segment.Identity segment, boolean idIsPersistent, 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
static CloseableCollection<Document>	openmdxjdoGetObjectsByParent(Segment segment) Navigate through an object's composite association
protected int	openmdxjdoGetSize(int field)
protected <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E>	openmdxjdoGetSlices()
protected void	openmdxjdoSetSize(int field, int size)
<T extends ModifySecureObjectResult> T	removeAllOwningGroup(short mode)
<T extends ModifySecureObjectResult> T	removeOwningGroup(PrincipalGroup group, short mode)
<T extends ModifySecureObjectResult> T	setAccessLevel(short accessLevelBrowse, short accessLevelDelete, short accessLevelUpdate, short mode)
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	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.
<T extends ModifySecureObjectResult> T	setOwningUser(short mode, User user)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
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.
<T extends org.openmdx.base.cci2.Void> T	updateIndex()

Methods inherited from class org.w3c.jdo2.AbstractObject

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

Methods inherited from class org.oasisopen.jdo2.Identifiable

openmdxjdoGetIdentity, openmdxjdoGetIdentity, 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.

exportXml

public <T extends ExportResult> T exportXml(String attributeFilter,
                                            String referenceFilter)
                                 throws RefException

Specified by:

exportXml in interface XmlExporter

Throws:

RefException

getDocumentType

public short getDocumentType()

Retrieves the value for the attribute documentType.

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.

Specified by:

setDocumentType in interface Document

Parameters:

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

getModifiedAt

public Date getModifiedAt()

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute modifiedAt.

getLocation

public final String getLocation()

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

Specified by:

getModifiedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

getActiveOn

public final Date getActiveOn()

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.

getContentType

public final String getContentType()

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.

getIdentity

public XRI getIdentity()

Retrieves the value for the derived attribute identity.

Specified by:

getIdentity in interface org.openmdx.base.cci2.ExtentCapable

Returns:

The non-null value for the attribute identity

getAuthor

public final String getAuthor()

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.

getRevision

public <T extends DocumentRevision> Collection<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.

getTitle

public final String getTitle()

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.

removeAllOwningGroup

public <T extends ModifySecureObjectResult> T removeAllOwningGroup(short mode)
                                                        throws RefException

Specified by:

removeAllOwningGroup in interface SecureObject

Throws:

RefException

getCreatedAt

public Date getCreatedAt()

Retrieves the value for the attribute createdAt.

Specified by:

getCreatedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute createdAt.

getDocumentNumber

public final String getDocumentNumber()

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 <T extends ModifySecureObjectResult> T setOwningUser(short mode,
                                                            User user)
                                                 throws RefException

Specified by:

setOwningUser in interface SecureObject

Throws:

RefException

getContentLength

public final Integer getContentLength()

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 <T extends ModifySecureObjectResult> T addOwningGroup(PrincipalGroup group,
                                                             short mode)
                                                  throws RefException

Specified by:

addOwningGroup in interface SecureObject

Throws:

RefException

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.

getActiveUntil

public final Date getActiveUntil()

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.

getDocumentState

public short getDocumentState()

Retrieves the value for the attribute documentState.

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.

Specified by:

setDocumentState in interface Document

Parameters:

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

getKeywords

public final String getKeywords()

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.

getAudit

public <T extends AuditEntry> Collection<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.

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.

removeOwningGroup

public <T extends ModifySecureObjectResult> T removeOwningGroup(PrincipalGroup group,
                                                                short mode)
                                                     throws RefException

Specified by:

removeOwningGroup in interface SecureObject

Throws:

RefException

importItem

public <T extends ImportResult> T importItem(byte[] item,
                                             String itemMimeType,
                                             String itemName,
                                             short locale)
                                  throws RefException

Specified by:

importItem in interface Importer

Throws:

RefException

getDocumentAbstract

public final String getDocumentAbstract()

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.

updateIndex

public <T extends org.openmdx.base.cci2.Void> T updateIndex()
                                                 throws RefException

Specified by:

updateIndex in interface Indexed

Throws:

RefException

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.

getCreatedBy

public final Set<String> getCreatedBy()

Specified by:

getCreatedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

setAccessLevel

public <T extends ModifySecureObjectResult> T setAccessLevel(short accessLevelBrowse,
                                                             short accessLevelDelete,
                                                             short accessLevelUpdate,
                                                             short mode)
                                                  throws RefException

Specified by:

setAccessLevel in interface SecureObject

Throws:

RefException

getAccessGrantedByParent

public org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

getOwner

public final List<String> getOwner()

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

getIndexEntry

public <T extends IndexEntry> Collection<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()

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 org.openmdx.compatibility.view1.cci2.View> Collection<T> getView()

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

Specified by:

getView in interface org.openmdx.compatibility.view1.cci2.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.

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

setSegment

public void setSegment(Segment segment)

Sets a new value for the reference segment.

Specified by:

setSegment in interface Document

Parameters:

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

openmdxjdoGetObjectsByParent

public static CloseableCollection<Document> openmdxjdoGetObjectsByParent(Segment segment)

Navigate through an object's composite association

setSegment

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

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

Specified by:

setSegment in interface Document

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(org.openmdx.base.cci2.Segment.Identity segment,
                                            boolean idIsPersistent,
                                            String id)