public interface Document extends Document, Auditee, Exporter, Importer, Indexed, SecureObject, PropertySetHolder, org.openmdx.base.jmi1.BasicObject
Document
Document.Identity
Modifier and Type | Method and Description |
---|---|
void |
addAttachment(boolean idIsPersistent,
String id,
DocumentAttachment attachment)
Adds the specified element to the set of the values for the reference
attachment . |
void |
addAttachment(DocumentAttachment attachment)
Adds the specified element to the set of the values for the reference
attachment using an implementation-specific, reassignable qualifier. |
void |
addAttachment(String id,
DocumentAttachment attachment)
Adds the specified element to the set of the values for the reference
attachment using a reassignable qualifier. |
void |
addDocumentFolderAssignment(boolean idIsPersistent,
String id,
FolderAssignment documentFolderAssignment)
Adds the specified element to the set of the values for the reference
documentFolderAssignment . |
void |
addDocumentFolderAssignment(FolderAssignment documentFolderAssignment)
Adds the specified element to the set of the values for the reference
documentFolderAssignment using an implementation-specific, reassignable qualifier. |
void |
addDocumentFolderAssignment(String id,
FolderAssignment documentFolderAssignment)
Adds the specified element to the set of the values for the reference
documentFolderAssignment using a reassignable qualifier. |
void |
addLink(boolean idIsPersistent,
String id,
DocumentLink link)
Adds the specified element to the set of the values for the reference
link . |
void |
addLink(DocumentLink link)
Adds the specified element to the set of the values for the reference
link using an implementation-specific, reassignable qualifier. |
void |
addLink(String id,
DocumentLink link)
Adds the specified element to the set of the values for the reference
link using a reassignable qualifier. |
void |
addLock(boolean idIsPersistent,
String id,
DocumentLock lock)
Adds the specified element to the set of the values for the reference
lock . |
void |
addLock(DocumentLock lock)
Adds the specified element to the set of the values for the reference
lock using an implementation-specific, reassignable qualifier. |
void |
addLock(String id,
DocumentLock lock)
Adds the specified element to the set of the values for the reference
lock using a reassignable qualifier. |
void |
addRevision(boolean idIsPersistent,
String id,
DocumentRevision revision)
Adds the specified element to the set of the values for the reference
revision . |
void |
addRevision(DocumentRevision revision)
Adds the specified element to the set of the values for the reference
revision using an implementation-specific, reassignable qualifier. |
void |
addRevision(String id,
DocumentRevision revision)
Adds the specified element to the set of the values for the reference
revision using a reassignable qualifier. |
DocumentAttachment |
getAttachment(boolean idIsPersistent,
String id)
Retrieves the value for the reference
attachment for the specified qualifier attribute value. |
<T extends DocumentAttachment> |
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. |
List<Short> |
getContentLanguage()
Retrieves a list containing all the elements for the attribute
contentLanguage . |
FolderAssignment |
getDocumentFolderAssignment(boolean idIsPersistent,
String id)
Retrieves the value for the reference
documentFolderAssignment for the specified qualifier attribute value. |
<T extends FolderAssignment> |
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. |
DocumentReference |
getDocumentReference(boolean idIsPersistent,
String id)
Retrieves the value for the reference
documentReference for the specified qualifier attribute value. |
<T extends DocumentReference> |
getDocumentReference(DocumentReferenceQuery query)
Retrieves the value for the reference
documentReference for the specified query. |
DocumentReference |
getDocumentReference(String id)
Retrieves the value for the reference
documentReference 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> |
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> |
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> |
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 |
setContentLanguage(List<Short> contentLanguage)
Clears
contentLanguage and adds the members of the given List. |
void |
setHeadRevision(DocumentRevision headRevision)
Sets a new value for the reference
headRevision . |
void |
setParent(Document parent)
Sets a new value for the reference
parent . |
getActiveOn, getActiveUntil, getAttachment, getAuthor, getCmsClass, getCmsDefaultLanguage, getCmsLanguage, getCmsMeta, getCmsTemplate, getCmsTranslation, getContentLength, getContentType, getDescription, getDocumentAbstract, getDocumentFolderAssignment, getDocumentNumber, getDocumentReference, 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
exportItem, exportItemAdvanced
exportItem, exportItemAdvanced
importItem
importItem
getIndexEntry, getIndexEntry, getIndexEntry, updateIndex
getIndexEntry
addOwningGroup, checkPermissions, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwner, setOwningUser, setOwningUser
addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser
addPropertySet, addPropertySet, addPropertySet, getPropertySet, getPropertySet, getPropertySet
getPropertySet
refDefaultFetchGroup, refDelegate, refGetPath, refGetValue, refInitialize, refInitialize, refSetValue
refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite
<T extends DocumentAttachment> List<T> getAttachment(DocumentAttachmentQuery query)
attachment
for the specified query.
Note: This is an extension to the JMI 1 standard.java.jdo.Query
query
- predicate which is applied to the set of referenced objects.true
.DocumentAttachment getAttachment(boolean idIsPersistent, String id)
attachment
for the specified qualifier attribute value.
idIsPersistent
- Defines whether value for the qualifier is persistent or notid
- The value for the qualifier attribute that qualifies this reference.DocumentAttachment getAttachment(String id)
attachment
for the specified qualifier attribute value.
This method is equivalent to the preferred invocation getAttachment(false,id)
.
id
- The value for the qualifier attribute that qualifies this reference.void addAttachment(boolean idIsPersistent, String id, DocumentAttachment attachment)
attachment
.
Note: This is an extension to the JMI 1 standard.
idIsPersistent
- true
if id
is persistentid
- The qualifier attribute value that qualifies the reference to get the element to be appended.attachment
- The element to be appended.void addAttachment(String id, DocumentAttachment attachment)
attachment
using a reassignable qualifier.
Note: This is an extension to the JMI 1 standard.
id
- The qualifier attribute value that qualifies the reference to get the element to be appended.attachment
- The element to be appended.void addAttachment(DocumentAttachment attachment)
attachment
using an implementation-specific, reassignable qualifier.
Note: This is an extension to the JMI 1 standard.
attachment
- The element to be appended.List<Short> getContentLanguage()
contentLanguage
.getContentLanguage
in interface Document
void setContentLanguage(List<Short> contentLanguage)
contentLanguage
and adds the members of the given List.
This method is equivalent to
list.clear(); list.addAll(contentLanguage);Note: This is an extension to the JMI 1 standard.
contentLanguage
- collection to be copied.<T extends FolderAssignment> List<T> getDocumentFolderAssignment(FolderAssignmentQuery query)
documentFolderAssignment
for the specified query.
Note: This is an extension to the JMI 1 standard.java.jdo.Query
query
- predicate which is applied to the set of referenced objects.true
.FolderAssignment getDocumentFolderAssignment(boolean idIsPersistent, String id)
documentFolderAssignment
for the specified qualifier attribute value.
idIsPersistent
- Defines whether value for the qualifier is persistent or notid
- The value for the qualifier attribute that qualifies this reference.FolderAssignment getDocumentFolderAssignment(String id)
documentFolderAssignment
for the specified qualifier attribute value.
This method is equivalent to the preferred invocation getDocumentFolderAssignment(false,id)
.
id
- The value for the qualifier attribute that qualifies this reference.void addDocumentFolderAssignment(boolean idIsPersistent, String id, FolderAssignment documentFolderAssignment)
documentFolderAssignment
.
Note: This is an extension to the JMI 1 standard.
idIsPersistent
- true
if id
is persistentid
- The qualifier attribute value that qualifies the reference to get the element to be appended.documentFolderAssignment
- The element to be appended.void addDocumentFolderAssignment(String id, FolderAssignment documentFolderAssignment)
documentFolderAssignment
using a reassignable qualifier.
Note: This is an extension to the JMI 1 standard.
id
- The qualifier attribute value that qualifies the reference to get the element to be appended.documentFolderAssignment
- The element to be appended.void addDocumentFolderAssignment(FolderAssignment documentFolderAssignment)
documentFolderAssignment
using an implementation-specific, reassignable qualifier.
Note: This is an extension to the JMI 1 standard.
documentFolderAssignment
- The element to be appended.<T extends DocumentReference> List<T> getDocumentReference(DocumentReferenceQuery query)
documentReference
for the specified query.
Note: This is an extension to the JMI 1 standard.java.jdo.Query
query
- predicate which is applied to the set of referenced objects.true
.DocumentReference getDocumentReference(boolean idIsPersistent, String id)
documentReference
for the specified qualifier attribute value.
idIsPersistent
- Defines whether value for the qualifier is persistent or notid
- The value for the qualifier attribute that qualifies this reference.DocumentReference getDocumentReference(String id)
documentReference
for the specified qualifier attribute value.
This method is equivalent to the preferred invocation getDocumentReference(false,id)
.
id
- The value for the qualifier attribute that qualifies this reference.DocumentRevision getHeadRevision()
headRevision
.getHeadRevision
in interface Document
null
– value for this reference.void setHeadRevision(DocumentRevision headRevision)
headRevision
.setHeadRevision
in interface Document
headRevision
- The new – possibly null
– value for this reference.<T extends DocumentLink> List<T> getLink(DocumentLinkQuery query)
link
for the specified query.
Note: This is an extension to the JMI 1 standard.java.jdo.Query
query
- predicate which is applied to the set of referenced objects.true
.DocumentLink getLink(boolean idIsPersistent, String id)
link
for the specified qualifier attribute value.
idIsPersistent
- Defines whether value for the qualifier is persistent or notid
- The value for the qualifier attribute that qualifies this reference.DocumentLink getLink(String id)
link
for the specified qualifier attribute value.
This method is equivalent to the preferred invocation getLink(false,id)
.
id
- The value for the qualifier attribute that qualifies this reference.void addLink(boolean idIsPersistent, String id, DocumentLink link)
link
.
Note: This is an extension to the JMI 1 standard.
idIsPersistent
- true
if id
is persistentid
- The qualifier attribute value that qualifies the reference to get the element to be appended.link
- The element to be appended.void addLink(String id, DocumentLink link)
link
using a reassignable qualifier.
Note: This is an extension to the JMI 1 standard.
id
- The qualifier attribute value that qualifies the reference to get the element to be appended.link
- The element to be appended.void addLink(DocumentLink link)
link
using an implementation-specific, reassignable qualifier.
Note: This is an extension to the JMI 1 standard.
link
- The element to be appended.<T extends DocumentLock> List<T> getLock(DocumentLockQuery query)
lock
for the specified query.
Note: This is an extension to the JMI 1 standard.java.jdo.Query
query
- predicate which is applied to the set of referenced objects.true
.DocumentLock getLock(boolean idIsPersistent, String id)
lock
for the specified qualifier attribute value.
idIsPersistent
- Defines whether value for the qualifier is persistent or notid
- The value for the qualifier attribute that qualifies this reference.DocumentLock getLock(String id)
lock
for the specified qualifier attribute value.
This method is equivalent to the preferred invocation getLock(false,id)
.
id
- The value for the qualifier attribute that qualifies this reference.void addLock(boolean idIsPersistent, String id, DocumentLock lock)
lock
.
Note: This is an extension to the JMI 1 standard.
idIsPersistent
- true
if id
is persistentid
- The qualifier attribute value that qualifies the reference to get the element to be appended.lock
- The element to be appended.void addLock(String id, DocumentLock lock)
lock
using a reassignable qualifier.
Note: This is an extension to the JMI 1 standard.
id
- The qualifier attribute value that qualifies the reference to get the element to be appended.lock
- The element to be appended.void addLock(DocumentLock lock)
lock
using an implementation-specific, reassignable qualifier.
Note: This is an extension to the JMI 1 standard.
lock
- The element to be appended.Document getParent()
parent
.void setParent(Document parent)
parent
.<T extends DocumentRevision> List<T> getRevision(DocumentRevisionQuery query)
revision
for the specified query.
Note: This is an extension to the JMI 1 standard.java.jdo.Query
query
- predicate which is applied to the set of referenced objects.true
.DocumentRevision getRevision(boolean idIsPersistent, String id)
revision
for the specified qualifier attribute value.
idIsPersistent
- Defines whether value for the qualifier is persistent or notid
- The value for the qualifier attribute that qualifies this reference.DocumentRevision getRevision(String id)
revision
for the specified qualifier attribute value.
This method is equivalent to the preferred invocation getRevision(false,id)
.
id
- The value for the qualifier attribute that qualifies this reference.void addRevision(boolean idIsPersistent, String id, DocumentRevision revision)
revision
.
Note: This is an extension to the JMI 1 standard.
idIsPersistent
- true
if id
is persistentid
- The qualifier attribute value that qualifies the reference to get the element to be appended.revision
- The element to be appended.void addRevision(String id, DocumentRevision revision)
revision
using a reassignable qualifier.
Note: This is an extension to the JMI 1 standard.
id
- The qualifier attribute value that qualifies the reference to get the element to be appended.revision
- The element to be appended.void addRevision(DocumentRevision revision)
revision
using an implementation-specific, reassignable qualifier.
Note: This is an extension to the JMI 1 standard.
revision
- The element to be appended.This software is published under the BSD license. Copyright © 2003-${build.year}, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.