org.opencrx.kernel.document1.jmi1
Interface Document

All Superinterfaces:

Auditee, BasicObject, ContextCapable, Document, Exporter, ExtentCapable, Importer, Indexed, PropertySetHolder, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, ViewCapable

public interface Document
extends Document, Auditee, Exporter, Importer, Indexed, SecureObject, PropertySetHolder, BasicObject

Class Document

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencrx.kernel.document1.cci2.Document

Document.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	addDocumentFolderAssignment(boolean idIsPersistent, String id, FolderAssignment documentFolderAssignment) Adds the specified element to the set of the values for the reference documentFolderAssignment.
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	addRevision(boolean idIsPersistent, String id, DocumentRevision revision) Adds the specified element to the set of the values for the reference revision.
DocumentAttachment	getAttachment(boolean idIsPersistent, String id) Retrieves the value for the reference attachment for the specified qualifier attribute value.
<T extends DocumentAttachment> List<T>	getAttachment(DocumentAttachmentQuery query) Retrieves the value for the reference attachment for the specified query.
DocumentAttachment	getAttachment(String id) Retrieves the value for the reference attachment for the specified qualifier attribute value.
FolderAssignment	getDocumentFolderAssignment(boolean idIsPersistent, String id) Retrieves the value for the reference documentFolderAssignment for the specified qualifier attribute value.
<T extends FolderAssignment> List<T>	getDocumentFolderAssignment(FolderAssignmentQuery query) Retrieves the value for the reference documentFolderAssignment for the specified query.
FolderAssignment	getDocumentFolderAssignment(String id) Retrieves the value for the reference documentFolderAssignment for the specified qualifier attribute value.
DocumentRevision	getHeadRevision() Retrieves the value for the reference headRevision.
DocumentLink	getLink(boolean idIsPersistent, String id) Retrieves the value for the reference link for the specified qualifier attribute value.
<T extends DocumentLink> List<T>	getLink(DocumentLinkQuery query) Retrieves the value for the reference link for the specified query.
DocumentLink	getLink(String id) Retrieves the value for the reference link for the specified qualifier attribute value.
DocumentLock	getLock(boolean idIsPersistent, String id) Retrieves the value for the reference lock for the specified qualifier attribute value.
<T extends DocumentLock> List<T>	getLock(DocumentLockQuery query) Retrieves the value for the reference lock for the specified query.
DocumentLock	getLock(String id) Retrieves the value for the reference lock for the specified qualifier attribute value.
Document	getParent() Retrieves the value for the reference parent.
DocumentRevision	getRevision(boolean idIsPersistent, String id) Retrieves the value for the reference revision for the specified qualifier attribute value.
<T extends DocumentRevision> List<T>	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.
void	setHeadRevision(DocumentRevision headRevision) Sets a new value for the reference headRevision.
void	setParent(Document parent) Sets a new value for the reference parent.

Methods inherited from interface org.opencrx.kernel.document1.cci2.Document

getActiveOn, getActiveUntil, getAttachment, getAuthor, getCmsClass, getCmsDefaultLanguage, getCmsLanguage, getCmsMeta, getCmsTemplate, getCmsTranslation, getContentLanguage, getContentLength, getContentType, getDescription, getDocumentAbstract, getDocumentFolderAssignment, getDocumentNumber, getDocumentState, getDocumentType, getFolder, getKeywords, getLink, getLiteratureType, getLocation, getLock, getName, getQualifiedName, getRevision, getSearchText, getTitle, isDisabled, setActiveOn, setActiveUntil, setAuthor, setCmsClass, setCmsDefaultLanguage, setCmsLanguage, setCmsMeta, setCmsTemplate, setCmsTranslation, setContentLanguage, setContentLength, setContentType, setDescription, setDisabled, setDocumentAbstract, setDocumentNumber, setDocumentState, setDocumentType, setKeywords, setLiteratureType, setLocation, setName, setQualifiedName, setSearchText, setTitle

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

getAudit, getAudit, getAudit

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

getAudit

Methods inherited from interface org.opencrx.kernel.base.jmi1.Exporter

exportItem, exportItemAdvanced

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

exportItem, exportItemAdvanced

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

importItem

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

importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, updateIndex

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

getIndexEntry

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

addOwningGroup, checkPermissions, getAccessGrantedByParent, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwningUser, setOwningUser

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

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser

Methods inherited from interface org.opencrx.kernel.document1.jmi1.PropertySetHolder

addPropertySet, getPropertySet, getPropertySet, getPropertySet

Methods inherited from interface org.opencrx.kernel.document1.cci2.PropertySetHolder

getPropertySet

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

getCreatedBy, getModifiedBy

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

getCreatedAt, getModifiedAt

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

getContext

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

getIdentity

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

getView, getView, getView

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

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

getAttachment

<T extends DocumentAttachment> List<T> getAttachment(DocumentAttachmentQuery query)

Retrieves the value for the reference attachment for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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

getAttachment

DocumentAttachment getAttachment(String id)

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

This method is equivalent to the preferred invocation getAttachment(false,id).

Parameters:

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.

getDocumentFolderAssignment

<T extends FolderAssignment> List<T> getDocumentFolderAssignment(FolderAssignmentQuery query)

Retrieves the value for the reference documentFolderAssignment for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getDocumentFolderAssignment

FolderAssignment getDocumentFolderAssignment(boolean idIsPersistent,
                                             String id)

Retrieves the value for the reference documentFolderAssignment 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

getDocumentFolderAssignment

FolderAssignment getDocumentFolderAssignment(String id)

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

This method is equivalent to the preferred invocation getDocumentFolderAssignment(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addDocumentFolderAssignment

void addDocumentFolderAssignment(boolean idIsPersistent,
                                 String id,
                                 FolderAssignment documentFolderAssignment)

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

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.

documentFolderAssignment - The element to be appended.

getHeadRevision

DocumentRevision getHeadRevision()

Retrieves the value for the reference headRevision.

Specified by:

getHeadRevision in interface Document

Returns:

The – possibly null – value for this reference.

setHeadRevision

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.

getLink

<T extends DocumentLink> List<T> getLink(DocumentLinkQuery query)

Retrieves the value for the reference link for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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

getLink

DocumentLink getLink(String id)

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

This method is equivalent to the preferred invocation getLink(false,id).

Parameters:

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.

getLock

<T extends DocumentLock> List<T> getLock(DocumentLockQuery query)

Retrieves the value for the reference lock for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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

getLock

DocumentLock getLock(String id)

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

This method is equivalent to the preferred invocation getLock(false,id).

Parameters:

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.

getParent

Document getParent()

Retrieves the value for the reference parent.

Specified by:

getParent in interface Document

Returns:

The – possibly null – value for this reference.

setParent

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.

getRevision

<T extends DocumentRevision> List<T> getRevision(DocumentRevisionQuery query)

Retrieves the value for the reference revision for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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

getRevision

DocumentRevision getRevision(String id)

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

This method is equivalent to the preferred invocation getRevision(false,id).

Parameters:

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.