org.opencrx.kernel.document1.cci2
Interface Segment

All Superinterfaces:

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

All Known Subinterfaces:

Segment

public interface Segment
extends 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(boolean idIsPersistent, String id, Document document) Adds the specified element to the set of the values for the reference document.
void	addFolder(boolean idIsPersistent, String id, DocumentFolder folder) Adds the specified element to the set of the values for the reference folder.
<T extends Document> Collection<T>	getDocument() Retrieves a set containing all the elements for the reference document.
Document	getDocument(boolean idIsPersistent, String id) Retrieves the value for the reference document for the specified qualifier attribute value.
<T extends DocumentFolder> Collection<T>	getFolder() Retrieves a set containing all the elements for the reference folder.
DocumentFolder	getFolder(boolean idIsPersistent, String id) Retrieves the value for the reference folder for the specified qualifier attribute value.

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

getDescription, getProvider, setDescription

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

getView, getView

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

getAudit, getAudit

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

importItem

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

getIndexEntry, getIndexEntry, updateIndex

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

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

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

exportXml

Method Detail

getDocument

<T extends Document> Collection<T> getDocument()

Retrieves a set containing all the elements for the reference document.

Returns:

A set containing all the elements for this reference.

getDocument

Document getDocument(boolean idIsPersistent,
                     String id)

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

addDocument

void addDocument(boolean idIsPersistent,
                 String id,
                 Document document)

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

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.

document - The element to be appended.

getFolder

<T extends DocumentFolder> Collection<T> getFolder()

Retrieves a set containing all the elements for the reference folder.

Returns:

A set containing all the elements for this reference.

getFolder

DocumentFolder getFolder(boolean idIsPersistent,
                         String id)

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

addFolder

void addFolder(boolean idIsPersistent,
               String id,
               DocumentFolder folder)

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

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.

folder - The element to be appended.