org.opencrx.kernel.model1.jmi1
Interface Reference

All Superinterfaces:

AlertSender, Auditee, org.openmdx.base.cci2.BasicObject, Cloneable, org.openmdx.base.cci2.ContextCapable, CrxObject, Element, org.openmdx.base.cci2.ExtentCapable, Feature, Importer, Indexed, RefBaseObject, Reference, RefFeatured, RefObject, SecureObject, StructuralFeature, SubscriptionTarget, TypedElement, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter

public interface Reference
extends Reference, StructuralFeature

Class Reference

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencrx.kernel.model1.cci2.Element

Element.Identity

Method Summary

void	addAdditionalExternalLink(AdditionalExternalLink newValue)
void	addAdditionalExternalLink(String id, AdditionalExternalLink newValue)
void	addAttachedDocument(DocumentAttachment newValue)
void	addAttachedDocument(String id, DocumentAttachment newValue)
void	addMedia(Media newValue)
void	addMedia(String id, Media newValue)
void	addNote(Note newValue)
void	addNote(String id, Note newValue)
void	addOwningGroup(int index, PrincipalGroup newValue)
void	addOwningGroup(PrincipalGroup newValue)
void	addPropertySet(PropertySet newValue)
void	addPropertySet(String id, PropertySet newValue)
void	addRating(Rating newValue)
void	addRating(String id, Rating newValue)
org.openmdx.base.cci2.BasicObject	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
<T extends AdditionalExternalLink> List<T>	getAdditionalExternalLink(AdditionalExternalLinkQuery query) Retrieves the value for the reference additionalExternalLink for the specified query.
<T extends DocumentAttachment> List<T>	getAttachedDocument(DocumentAttachmentQuery query) Retrieves the value for the reference attachedDocument for the specified query.
<T extends AuditEntry> List<T>	getAudit(AuditEntryQuery query) Retrieves the value for the reference audit for the specified query.
Namespace	getContainer() Retrieves the value for the reference container.
AssociationEnd	getExposedEnd() Retrieves the value for the reference exposedEnd.
<T extends IndexEntry> List<T>	getIndexEntry(IndexEntryQuery query) Retrieves the value for the reference indexEntry for the specified query.
<T extends Media> List<T>	getMedia(MediaQuery query) Retrieves the value for the reference media for the specified query.
<T extends Note> List<T>	getNote(NoteQuery query) Retrieves the value for the reference note for the specified query.
User	getOwningUser() Retrieves the value for the reference owningUser.
<T extends PropertySet> List<T>	getPropertySet(PropertySetQuery query) Retrieves the value for the reference propertySet for the specified query.
<T extends PropertySetEntry> List<T>	getPropertySetEntry(PropertySetEntryQuery query) Retrieves the value for the reference propertySetEntry for the specified query.
<T extends Rating> List<T>	getRating(RatingQuery query) Retrieves the value for the reference rating for the specified query.
AssociationEnd	getReferencedEnd() Retrieves the value for the reference referencedEnd.
Segment	getSegment() Retrieves the value for the reference segment.
Classifier	getType() Retrieves the value for the reference type.
<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	removeAdditionalExternalLink(String id)
void	removeAttachedDocument(String id)
void	removeContainer() Removes the value for the optional reference container.
void	removeMedia(String id)
void	removeNote(String id)
void	removeOwningGroup(int index)
void	removeOwningUser() Removes the value for the optional reference owningUser.
void	removePropertySet(String id)
void	removeRating(String id)
void	setContainer(Namespace container) Sets a new value for the reference container.
void	setExposedEnd(AssociationEnd exposedEnd) Sets a new value for the reference exposedEnd.
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
void	setReferencedEnd(AssociationEnd referencedEnd) Sets a new value for the reference referencedEnd.
void	setType(Classifier type) Sets a new value for the reference type.

Methods inherited from interface org.opencrx.kernel.model1.cci2.StructuralFeature

getMultiplicity, getUpperBound, isChangeable, setChangeable, setMultiplicity, setUpperBound

Methods inherited from interface org.opencrx.kernel.model1.cci2.Feature

getScope, getVisibility, setScope, setVisibility

Methods inherited from interface org.opencrx.kernel.model1.jmi1.Element

getStereotype, setSegment, setSegment, setStereotype

Methods inherited from interface org.opencrx.kernel.model1.cci2.Element

getAnnotation, getElementOrder, getName, getQualifiedName, setAnnotation, setElementOrder, setName, setStereotype

Methods inherited from interface org.opencrx.kernel.generic.jmi1.CrxObject

getCategory, getExternalLink, getUserBoolean4, getUserCode4, getUserDate4, getUserDateTime4, getUserNumber4, getUserString4, setCategory, setExternalLink, setUserBoolean4, setUserCode4, setUserDate4, setUserDateTime4, setUserNumber4, setUserString4

Methods inherited from interface org.opencrx.kernel.generic.cci2.CrxObject

getAdditionalExternalLink, getAttachedDocument, getCategory, getDisabledReason, getExternalLink, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, setCategory, setDisabled, setDisabledReason, setExternalLink, 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.base.jmi1.AlertSender

sendAlert

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

sendAlert

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

getAudit

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

clone_

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

clone_

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

addSubscription, addSubscriptionForParent, removeSubscription, removeSubscriptionForParent

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

addSubscription, addSubscriptionForParent, removeSubscription, removeSubscriptionForParent

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.

getAdditionalExternalLink

<T extends AdditionalExternalLink> List<T> getAdditionalExternalLink(AdditionalExternalLinkQuery query)

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

addAdditionalExternalLink

void addAdditionalExternalLink(String id,
                               AdditionalExternalLink newValue)

Parameters:

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

newValue - The element to be appended.

addAdditionalExternalLink

void addAdditionalExternalLink(AdditionalExternalLink newValue)

Parameters:

newValue - The element to be appended.

removeAdditionalExternalLink

void removeAdditionalExternalLink(String id)

getAttachedDocument

<T extends DocumentAttachment> List<T> getAttachedDocument(DocumentAttachmentQuery query)

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

addAttachedDocument

void addAttachedDocument(String id,
                         DocumentAttachment newValue)

Parameters:

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

newValue - The element to be appended.

addAttachedDocument

void addAttachedDocument(DocumentAttachment newValue)

Parameters:

newValue - The element to be appended.

removeAttachedDocument

void removeAttachedDocument(String id)

getMedia

<T extends Media> List<T> getMedia(MediaQuery query)

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

addMedia

void addMedia(String id,
              Media newValue)

Parameters:

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

newValue - The element to be appended.

addMedia

void addMedia(Media newValue)

Parameters:

newValue - The element to be appended.

removeMedia

void removeMedia(String id)

getNote

<T extends Note> List<T> getNote(NoteQuery query)

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

addNote

void addNote(String id,
             Note newValue)

Parameters:

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

newValue - The element to be appended.

addNote

void addNote(Note newValue)

Parameters:

newValue - The element to be appended.

removeNote

void removeNote(String id)

getPropertySet

<T extends PropertySet> List<T> getPropertySet(PropertySetQuery query)

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

addPropertySet

void addPropertySet(String id,
                    PropertySet newValue)

Parameters:

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

newValue - The element to be appended.

addPropertySet

void addPropertySet(PropertySet newValue)

Parameters:

newValue - The element to be appended.

removePropertySet

void removePropertySet(String id)

getPropertySetEntry

<T extends PropertySetEntry> List<T> getPropertySetEntry(PropertySetEntryQuery query)

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

getRating

<T extends Rating> List<T> getRating(RatingQuery query)

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

addRating

void addRating(String id,
               Rating newValue)

Parameters:

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

newValue - The element to be appended.

addRating

void addRating(Rating newValue)

Parameters:

newValue - The element to be appended.

removeRating

void removeRating(String id)

getContainer

Namespace getContainer()

Retrieves the value for the reference container.

Specified by:

getContainer in interface Element

Returns:

The – possibly null – value for this reference.

setContainer

void setContainer(Namespace container)

Sets a new value for the reference container.

Specified by:

setContainer in interface Element

Parameters:

container - The non-null new value for this reference.

removeContainer

void removeContainer()

Removes the value for the optional reference container.

getSegment

Segment getSegment()

Retrieves the value for the reference segment.

Specified by:

getSegment in interface Element

Returns:

The non-null value for this reference.

getExposedEnd

AssociationEnd getExposedEnd()

Retrieves the value for the reference exposedEnd.

Specified by:

getExposedEnd in interface Reference

Returns:

The non-null value for this reference.

setExposedEnd

void setExposedEnd(AssociationEnd exposedEnd)

Sets a new value for the reference exposedEnd.

Specified by:

setExposedEnd in interface Reference

Parameters:

exposedEnd - The non-null new value for this reference.

getReferencedEnd

AssociationEnd getReferencedEnd()

Retrieves the value for the reference referencedEnd.

Specified by:

getReferencedEnd in interface Reference

Returns:

The non-null value for this reference.

setReferencedEnd

void setReferencedEnd(AssociationEnd referencedEnd)

Sets a new value for the reference referencedEnd.

Specified by:

setReferencedEnd in interface Reference

Parameters:

referencedEnd - The non-null new value for this reference.

getType

Classifier getType()

Retrieves the value for the reference type.

Specified by:

getType in interface TypedElement

Returns:

The non-null value for this reference.

setType

void setType(Classifier type)

Sets a new value for the reference type.

Specified by:

setType in interface TypedElement

Parameters:

type - The non-null new 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.