org.opencrx.kernel.generic.cci
Interface DescriptionContainer

All Superinterfaces:

RefBaseObject, RefFeatured, RefObject, RefObject_1_0

All Known Subinterfaces:

Artifact, Asset, AssetContext, Booking, ClassificationElement, CompoundBooking, CreditBooking, DebitBooking, Depot, DepotReport, DescriptorGroup, DesignDiagram, DesignModel, DesignPart, Event, ImplementationPart, InterfaceSpec, Part, Product, Profile, RequirementDiagram, RequirementModel, RequirementPart, SalesTaxType, Slot, SolutionPart, TestDiagram, TestModel, TestPart, Uom, UseCase

All Known Implementing Classes:

ArtifactImpl, AssetContextImpl, AssetImpl, BookingImpl, ClassificationElementImpl, CompoundBookingImpl, CreditBookingImpl, DebitBookingImpl, DepotImpl, DepotReportImpl, DescriptionContainerImpl, DescriptorGroupImpl, DesignDiagramImpl, DesignModelImpl, DesignPartImpl, EventImpl, ImplementationPartImpl, InterfaceSpecImpl, PartImpl, ProductImpl, ProfileImpl, RequirementDiagramImpl, RequirementModelImpl, RequirementPartImpl, SalesTaxTypeImpl, SlotImpl, SolutionPartImpl, TestDiagramImpl, TestModelImpl, TestPartImpl, UomImpl, UseCaseImpl

public interface DescriptionContainer
extends RefObject_1_0

Method Summary

void	addAdditionalDescription(Description newValue)
void	addAdditionalDescription(String id, Description newValue)
Collection	getAdditionalDescription() Retrieves a collection containing all the elements for the reference additionalDescription.
List	getAdditionalDescription(DescriptionFilter filter) Retrieves the value for the reference additionalDescription for the specified filter.
List	getAdditionalDescription(DescriptionQuery query) Retrieves the value for the reference additionalDescription for the specified query.
Description	getAdditionalDescription(String id) Retrieves the value for the reference additionalDescription for the specified qualifier attribute value.
void	removeAdditionalDescription(String id)

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

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

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

getAdditionalDescription

Description getAdditionalDescription(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAdditionalDescription

Collection getAdditionalDescription()

Retrieves a collection containing all the elements for the reference additionalDescription.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAdditionalDescription

List getAdditionalDescription(DescriptionFilter filter)

Retrieves the value for the reference additionalDescription for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAdditionalDescription

List getAdditionalDescription(DescriptionQuery query)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addAdditionalDescription

void addAdditionalDescription(String id,
                              Description newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addAdditionalDescription

void addAdditionalDescription(Description newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeAdditionalDescription

void removeAdditionalDescription(String id)

Throws:

JmiException - If the value cannot be removed for some reason.