org.opencrx.kernel.document1.jmi1

Interface Document

All Superinterfaces:

Auditee, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.Creatable, Document, Exporter, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, org.openmdx.base.cci2.Modifiable, PropertySetHolder, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, org.openmdx.base.accessor.jmi.cci.RefObject_1_0, SecureObject, UserDefined

public interface Document
extends Document, Auditee, Exporter, Importer, Indexed, SecureObject, UserDefined, PropertySetHolder, org.openmdx.base.jmi1.BasicObject

Class Document

Nested Class Summary

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

Document.Identity

Method Summary

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> 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.
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> 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.
DocumentReference	getDocumentReference(boolean idIsPersistent, String id) Retrieves the value for the reference documentReference for the specified qualifier attribute value.
<T extends DocumentReference> List<T>	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.
DocumentSchema	getDocumentSchema() Retrieves the value for the reference documentSchema.
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	setContentLanguage(List<Short> contentLanguage) Clears contentLanguage and adds the members of the given List.
void	setDocumentSchema(DocumentSchema documentSchema) Sets a new value for the reference documentSchema.
void	setHeadRevision(DocumentRevision headRevision) Sets a new value for the reference headRevision.
void	setParent(Document parent) Sets a new value for the reference parent.
ValidateSchemaResult	validateSchema()

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

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

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

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

exportItem

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, updateIndex

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

addOwningGroup, checkPermissions, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwner, 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, setOwner, setOwningUser

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

getUserBoolean4, getUserCode4, getUserDate4, getUserDateTime4, getUserNumber4, getUserString4, setUserBoolean4, setUserCode4, setUserDate4, setUserDateTime4, setUserNumber4, setUserString4

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

getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserString0, getUserString1, getUserString2, getUserString3, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4

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

addPropertySet, addPropertySet, addPropertySet, getPropertySet, getPropertySet, getPropertySet

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

getPropertySet

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

getCreatedBy

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

getCreatedAt

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

getIdentity

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

getModifiedBy

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

getModifiedAt

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

refDefaultFetchGroup, refDelegate, refGetPath, refGetValue, refInitialize, refInitialize, refSetValue

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.

addAttachment

void addAttachment(String id,
                   DocumentAttachment attachment)

Adds the specified element to the set of the values for the reference attachment using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

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

attachment - The element to be appended.

addAttachment

void addAttachment(DocumentAttachment attachment)

Adds the specified element to the set of the values for the reference attachment using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

attachment - The element to be appended.

getContentLanguage

List<Short> getContentLanguage()

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

Specified by:

getContentLanguage in interface Document

Returns:

A list containing all elements for this attribute.

setContentLanguage

void setContentLanguage(List<Short> contentLanguage)

Clears 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.
In order to remain standard compliant you should use the equivalent code.

Parameters:

contentLanguage - collection to be copied.

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.

addDocumentFolderAssignment

void addDocumentFolderAssignment(String id,
                                 FolderAssignment documentFolderAssignment)

Adds the specified element to the set of the values for the reference documentFolderAssignment using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

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

documentFolderAssignment - The element to be appended.

addDocumentFolderAssignment

void addDocumentFolderAssignment(FolderAssignment documentFolderAssignment)

Adds the specified element to the set of the values for the reference documentFolderAssignment using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

documentFolderAssignment - The element to be appended.

getDocumentReference

<T extends DocumentReference> List<T> getDocumentReference(DocumentReferenceQuery query)

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

getDocumentReference

DocumentReference getDocumentReference(boolean idIsPersistent,
                                       String id)

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

getDocumentReference

DocumentReference getDocumentReference(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

getDocumentSchema

DocumentSchema getDocumentSchema()

Retrieves the value for the reference documentSchema.

Specified by:

getDocumentSchema in interface Document

Returns:

The – possibly null – value for this reference.

setDocumentSchema

void setDocumentSchema(DocumentSchema documentSchema)

Sets a new value for the reference documentSchema.

Specified by:

setDocumentSchema in interface Document

Parameters:

documentSchema - The new – possibly null – value for this reference.

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 new – possibly null – 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.

addLink

void addLink(String id,
             DocumentLink link)

Adds the specified element to the set of the values for the reference link using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

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

link - The element to be appended.

addLink

void addLink(DocumentLink link)

Adds the specified element to the set of the values for the reference link using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

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.

addLock

void addLock(String id,
             DocumentLock lock)

Adds the specified element to the set of the values for the reference lock using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

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

lock - The element to be appended.

addLock

void addLock(DocumentLock lock)

Adds the specified element to the set of the values for the reference lock using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

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 new – possibly null – 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.

addRevision

void addRevision(String id,
                 DocumentRevision revision)

Adds the specified element to the set of the values for the reference revision using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

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

revision - The element to be appended.

addRevision

void addRevision(DocumentRevision revision)

Adds the specified element to the set of the values for the reference revision using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

revision - The element to be appended.

validateSchema

ValidateSchemaResult validateSchema()

Specified by:

validateSchema in interface Document