org.opencrx.kernel.document1.jmi1
Interface Segment

All Superinterfaces:

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

public interface Segment
extends Segment, Segment, Auditee, Importer, Indexed, SecureObject, XmlExporter

Class Segment

Nested Class Summary

Nested classes/interfaces inherited from interface org.openmdx.base.cci2.Segment

org.openmdx.base.cci2.Segment.Identity

Method Summary

void	addDocument(Document newValue)
void	addDocument(String id, Document newValue)
void	addFolder(DocumentFolder newValue)
void	addFolder(String id, DocumentFolder newValue)
void	addOwningGroup(int index, PrincipalGroup newValue)
void	addOwningGroup(PrincipalGroup 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.
<T extends Document> List<T>	getDocument(DocumentQuery query) Retrieves the value for the reference document for the specified query.
<T extends org.openmdx.base.cci2.ExtentCapable> List<T>	getExtent(org.openmdx.base.cci2.ExtentCapableQuery query) Retrieves the value for the reference extent for the specified query.
<T extends DocumentFolder> List<T>	getFolder(DocumentFolderQuery query) Retrieves the value for the reference folder for the specified query.
<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.
org.openmdx.base.jdo2.Provider	getProvider() Retrieves the value for the reference provider.
<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	removeDocument(String id)
void	removeFolder(String id)
void	removeOwningGroup(int index)
void	removeOwningUser() Removes the value for the optional reference owningUser.
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.

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

getDocument, getFolder

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

setProvider, setProvider

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

getDescription, setDescription

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

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

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.

getDocument

<T extends Document> List<T> getDocument(DocumentQuery query)

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

addDocument

void addDocument(String id,
                 Document newValue)

Parameters:

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

newValue - The element to be appended.

addDocument

void addDocument(Document newValue)

Parameters:

newValue - The element to be appended.

removeDocument

void removeDocument(String id)

getFolder

<T extends DocumentFolder> List<T> getFolder(DocumentFolderQuery query)

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

addFolder

void addFolder(String id,
               DocumentFolder newValue)

Parameters:

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

getExtent

<T extends org.openmdx.base.cci2.ExtentCapable> List<T> getExtent(org.openmdx.base.cci2.ExtentCapableQuery query)

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

getProvider

org.openmdx.base.jdo2.Provider getProvider()

Retrieves the value for the reference provider.

Specified by:

getProvider in interface org.openmdx.base.cci2.Segment

Returns:

The non-null value for this reference.

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.