org.opencrx.kernel.document1.jmi1
Interface Document

All Superinterfaces:

Auditee, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, Document, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, SecureObject, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter

public interface Document
extends Document, Auditee, Importer, Indexed, SecureObject, XmlExporter, 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

void	addFolder(DocumentFolder newValue)
void	addFolder(int index, DocumentFolder newValue)
void	addOwningGroup(int index, PrincipalGroup newValue)
void	addOwningGroup(PrincipalGroup newValue)
void	addRevision(DocumentRevision newValue)
void	addRevision(String id, DocumentRevision newValue)
org.openmdx.base.cci2.BasicObject	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
<T extends AuditEntry> List<T>	getAudit(AuditEntryQuery query) Retrieves the value for the reference audit for the specified query.
DocumentRevision	getHeadRevision() Retrieves the value for the reference headRevision.
<T extends IndexEntry> List<T>	getIndexEntry(IndexEntryQuery query) Retrieves the value for the reference indexEntry for the specified query.
User	getOwningUser() Retrieves the value for the reference owningUser.
<T extends DocumentRevision> List<T>	getRevision(DocumentRevisionQuery query) Retrieves the value for the reference revision for the specified query.
<T extends org.openmdx.compatibility.view1.cci2.View> List<T>	getView(org.openmdx.compatibility.view1.cci2.ViewQuery query) Retrieves the value for the reference view for the specified query.
void	removeFolder(int index)
void	removeHeadRevision() Removes the value for the optional reference headRevision.
void	removeOwningGroup(int index)
void	removeOwningUser() Removes the value for the optional reference owningUser.
void	removeRevision(String id)
void	setHeadRevision(DocumentRevision headRevision) Sets a new value for the reference headRevision.
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
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.

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

getActiveOn, getActiveUntil, getAuthor, getContentLanguage, getContentLength, getContentType, getDocumentAbstract, getDocumentNumber, getDocumentState, getDocumentType, getFolder, getKeywords, getLiteratureType, getLocation, getRevision, getSearchText, getTitle, setActiveOn, setActiveUntil, setAuthor, setContentLanguage, setContentLength, setContentType, setDocumentAbstract, setDocumentNumber, setDocumentState, setDocumentType, setKeywords, setLiteratureType, setLocation, setSearchText, setTitle

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

getAudit

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

updateIndex

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

getIndexEntry, updateIndex

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

addOwningGroup, getOwner, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setOwningUser

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

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

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

exportXml

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

exportXml

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

getIdentity

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

getView

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

getAudit

<T extends AuditEntry> List<T> getAudit(AuditEntryQuery query)

Retrieves the value for the reference audit for the specified query.

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getIndexEntry

<T extends IndexEntry> List<T> getIndexEntry(IndexEntryQuery query)

Retrieves the value for the reference indexEntry for the specified query.

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getAccessGrantedByParent

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.

addOwningGroup

void addOwningGroup(int index,
                    PrincipalGroup newValue)

Parameters:

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

newValue - The element to be appended.

addOwningGroup

void addOwningGroup(PrincipalGroup newValue)

Parameters:

newValue - The element to be appended.

removeOwningGroup

void removeOwningGroup(int index)

getOwningUser

User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

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.

removeOwningUser

void removeOwningUser()

Removes the value for the optional reference owningUser.

addFolder

void addFolder(int index,
               DocumentFolder newValue)

Parameters:

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

newValue - The element to be appended.

addFolder

void addFolder(DocumentFolder newValue)

Parameters:

newValue - The element to be appended.

removeFolder

void removeFolder(int index)

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.

removeHeadRevision

void removeHeadRevision()

Removes the value for the optional reference headRevision.

getRevision

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

Retrieves the value for the reference revision for the specified query.

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addRevision

void addRevision(String id,
                 DocumentRevision newValue)

Parameters:

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

newValue - The element to be appended.

addRevision

void addRevision(DocumentRevision newValue)

Parameters:

newValue - The element to be appended.

removeRevision

void removeRevision(String id)

getView

<T extends org.openmdx.compatibility.view1.cci2.View> List<T> getView(org.openmdx.compatibility.view1.cci2.ViewQuery query)

Retrieves the value for the reference view for the specified query.

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

setSegment

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.

setSegment

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.