org.opencrx.kernel.ras1.cci
Interface Artifact

All Superinterfaces:

AlertSender, Auditee, BasicObject, Cloneable, ContextCapable, CrxObject, DescriptionContainer, ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, SolutionPart, SubscriptionTarget, ViewCapable, XmlExporter

All Known Subinterfaces:

DesignDiagram, DesignModel, DesignPart, ImplementationPart, InterfaceSpec, RequirementDiagram, RequirementModel, RequirementPart, TestDiagram, TestModel, TestPart, UseCase

All Known Implementing Classes:

ArtifactImpl, DesignDiagramImpl, DesignModelImpl, DesignPartImpl, ImplementationPartImpl, InterfaceSpecImpl, RequirementDiagramImpl, RequirementModelImpl, RequirementPartImpl, TestDiagramImpl, TestModelImpl, TestPartImpl, UseCaseImpl

public interface Artifact
extends SolutionPart

Method Summary

void	addArtifactContext(ArtifactContext newValue)
void	addArtifactContext(String id, ArtifactContext newValue)
void	addDependency(ArtifactDependency newValue)
void	addDependency(String id, ArtifactDependency newValue)
void	addVp(String id, VariabilityPoint newValue)
void	addVp(VariabilityPoint newValue)
Collection	getArtifactContext() Retrieves a collection containing all the elements for the reference artifactContext.
List	getArtifactContext(ArtifactContextFilter filter) Retrieves the value for the reference artifactContext for the specified filter.
List	getArtifactContext(ArtifactContextQuery query) Retrieves the value for the reference artifactContext for the specified query.
ArtifactContext	getArtifactContext(String id) Retrieves the value for the reference artifactContext for the specified qualifier attribute value.
String	getArtifactType() Retrieves the value for the attribute artifactType.
Collection	getDependency() Retrieves a collection containing all the elements for the reference dependency.
List	getDependency(ArtifactDependencyFilter filter) Retrieves the value for the reference dependency for the specified filter.
List	getDependency(ArtifactDependencyQuery query) Retrieves the value for the reference dependency for the specified query.
ArtifactDependency	getDependency(String id) Retrieves the value for the reference dependency for the specified qualifier attribute value.
String	getDigestName()
String	getDigestValue()
String	getVersion()
Collection	getVp() Retrieves a collection containing all the elements for the reference vp.
VariabilityPoint	getVp(String id) Retrieves the value for the reference vp for the specified qualifier attribute value.
List	getVp(VariabilityPointFilter filter) Retrieves the value for the reference vp for the specified filter.
List	getVp(VariabilityPointQuery query) Retrieves the value for the reference vp for the specified query.
void	removeArtifactContext(String id)
void	removeDependency(String id)
void	removeVp(String id)
void	setArtifactType(String newValue) Sets a new value for the attribute artifactType.
void	setDigestName(String newValue) Sets a new value for the attribute digestName.
void	setDigestValue(String newValue) Sets a new value for the attribute digestValue.
void	setVersion(String newValue) Sets a new value for the attribute version.

Methods inherited from interface org.opencrx.kernel.ras1.cci.SolutionPart

getDescription, getName, setDescription, setName

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

addAdditionalExternalLink, addAdditionalExternalLink, addAttachedDocument, addAttachedDocument, addMedia, addMedia, addNote, addNote, addPropertySet, addPropertySet, addRating, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getCategory, getDisabledReason, getExternalLink, getExternalLink, getMedia, getMedia, getMedia, getMedia, getNote, getNote, getNote, getNote, getPropertySet, getPropertySet, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getRating, getRating, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, isUserBoolean4, isUserBoolean4, removeAdditionalExternalLink, removeAttachedDocument, removeMedia, removeNote, removePropertySet, removeRating, setCategory, setCategory, setDisabled, setDisabledReason, setExternalLink, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4, setUserString4

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

sendAlert, sendAlert

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

getAudit, getAudit, getAudit, getAudit

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

clone_, clone_

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

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

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

addSubscription, addSubscription, addSubscriptionForParent, addSubscriptionForParent, removeSubscription, removeSubscription, removeSubscriptionForParent, removeSubscriptionForParent

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

exportXml, exportXml

Methods inherited from interface org.openmdx.base.cci.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

Methods inherited from interface org.openmdx.base.cci.ExtentCapable

getIdentity

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

getView, getView, getView, getView

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

Methods inherited from interface org.opencrx.kernel.generic.cci.DescriptionContainer

addAdditionalDescription, addAdditionalDescription, getAdditionalDescription, getAdditionalDescription, getAdditionalDescription, getAdditionalDescription, removeAdditionalDescription

Method Detail

getArtifactContext

ArtifactContext getArtifactContext(String id)

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

getArtifactContext

Collection getArtifactContext()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getArtifactContext

List getArtifactContext(ArtifactContextFilter filter)

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

getArtifactContext

List getArtifactContext(ArtifactContextQuery query)

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

addArtifactContext

void addArtifactContext(String id,
                        ArtifactContext 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.

addArtifactContext

void addArtifactContext(ArtifactContext newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeArtifactContext

void removeArtifactContext(String id)

Throws:

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

getArtifactType

String getArtifactType()

Retrieves the value for the attribute artifactType.

Returns:

The non-null value for attribute artifactType.

Throws:

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

setArtifactType

void setArtifactType(String newValue)

Sets a new value for the attribute artifactType.

Parameters:

newValue - The non-null new value for attribute artifactType.

Throws:

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

getDependency

ArtifactDependency getDependency(String id)

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

getDependency

Collection getDependency()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getDependency

List getDependency(ArtifactDependencyFilter filter)

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

getDependency

List getDependency(ArtifactDependencyQuery query)

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

addDependency

void addDependency(String id,
                   ArtifactDependency 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.

addDependency

void addDependency(ArtifactDependency newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeDependency

void removeDependency(String id)

Throws:

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

getDigestName

String getDigestName()

Returns:

The possibly null value for attribute digestName.

Throws:

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

setDigestName

void setDigestName(String newValue)

Sets a new value for the attribute digestName.

Parameters:

newValue - The possibly null new value for attribute digestName.

Throws:

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

getDigestValue

String getDigestValue()

Returns:

The possibly null value for attribute digestValue.

Throws:

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

setDigestValue

void setDigestValue(String newValue)

Sets a new value for the attribute digestValue.

Parameters:

newValue - The possibly null new value for attribute digestValue.

Throws:

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

getVersion

String getVersion()

Returns:

The possibly null value for attribute version.

Throws:

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

setVersion

void setVersion(String newValue)

Sets a new value for the attribute version.

Parameters:

newValue - The possibly null new value for attribute version.

Throws:

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

getVp

VariabilityPoint getVp(String id)

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

getVp

Collection getVp()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getVp

List getVp(VariabilityPointFilter filter)

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

getVp

List getVp(VariabilityPointQuery query)

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

addVp

void addVp(String id,
           VariabilityPoint 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.

addVp

void addVp(VariabilityPoint newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeVp

void removeVp(String id)

Throws:

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