Package org.eclipse.epf.uma

Interface ArtifactDescription

All Superinterfaces:

ContentDescription, Element, org.eclipse.emf.ecore.EObject, MethodElement, MethodUnit, NamedElement, org.eclipse.emf.common.notify.Notifier, PackageableElement, WorkProductDescription

All Known Implementing Classes:

ArtifactDescriptionImpl

public interface ArtifactDescription
extends WorkProductDescription

A representation of the model object 'Artifact Description'.

The following features are supported:

• Brief Outline
• Representation Options
• Representation
• Notation

See Also:

UmaPackage.getArtifactDescription()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBriefOutline()	Returns the value of the 'Brief Outline' attribute.
java.lang.String	getNotation()	Returns the value of the 'Notation' attribute.
java.lang.String	getRepresentation()	Returns the value of the 'Representation' attribute.
java.lang.String	getRepresentationOptions()	Returns the value of the 'Representation Options' attribute.
void	setBriefOutline(java.lang.String value)	Sets the value of the 'Brief Outline' attribute.
void	setNotation(java.lang.String value)	Sets the value of the 'Notation' attribute.
void	setRepresentation(java.lang.String value)	Sets the value of the 'Representation' attribute.
void	setRepresentationOptions(java.lang.String value)	Sets the value of the 'Representation Options' attribute.

Methods inherited from interface org.eclipse.epf.uma.ContentDescription

getExternalId, getKeyConsiderations, getLongPresentationName, getMainDescription, getSections, setExternalId, setKeyConsiderations, setLongPresentationName, setMainDescription

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.epf.uma.MethodElement

getBriefDescription, getGuid, getKind, getMethodElementProperty, getOrderingGuide, getOwnedRules, getPresentationName, getSuppressed, setBriefDescription, setGuid, setOrderingGuide, setPresentationName, setSuppressed

Methods inherited from interface org.eclipse.epf.uma.MethodUnit

getAuthors, getChangeDate, getChangeDescription, getCopyrightStatement, getVersion, setAuthors, setChangeDate, setChangeDescription, setCopyrightStatement, setVersion

Methods inherited from interface org.eclipse.epf.uma.NamedElement

getName, setName

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface org.eclipse.epf.uma.WorkProductDescription

getImpactOfNotHaving, getPurpose, getReasonsForNotNeeding, setImpactOfNotHaving, setPurpose, setReasonsForNotNeeding

Method Details

getBriefOutline

java.lang.String getBriefOutline()

Returns the value of the 'Brief Outline' attribute. The default value is "". Provides a brief description of the information that can be found in this artifact. For example, discusses the contents for key chapters of a document artifact or the key packages and modules of a model artifact.

Returns:

the value of the 'Brief Outline' attribute.

See Also:

setBriefOutline(String), UmaPackage.getArtifactDescription_BriefOutline()

setBriefOutline

void setBriefOutline(java.lang.String value)

Sets the value of the 'Brief Outline' attribute.

Parameters:

value - the new value of the 'Brief Outline' attribute.

See Also:

getBriefOutline()

getRepresentationOptions

java.lang.String getRepresentationOptions()

Returns the value of the 'Representation Options' attribute. The default value is "". Discusses different possible alternative representations for the artifact. For example a design model can be represented as a UML model or an informal block diagram or by textual description only.

Returns:

the value of the 'Representation Options' attribute.

See Also:

setRepresentationOptions(String), UmaPackage.getArtifactDescription_RepresentationOptions()

setRepresentationOptions

void setRepresentationOptions(java.lang.String value)

Sets the value of the 'Representation Options' attribute.

Parameters:

value - the new value of the 'Representation Options' attribute.

See Also:

getRepresentationOptions()

getRepresentation

java.lang.String getRepresentation()

Returns the value of the 'Representation' attribute. The default value is "".

Returns:

the value of the 'Representation' attribute.

See Also:

setRepresentation(String), UmaPackage.getArtifactDescription_Representation()

setRepresentation

void setRepresentation(java.lang.String value)

Sets the value of the 'Representation' attribute.

Parameters:

value - the new value of the 'Representation' attribute.

See Also:

getRepresentation()

getNotation

java.lang.String getNotation()

Returns the value of the 'Notation' attribute. The default value is "".

Returns:

the value of the 'Notation' attribute.

See Also:

setNotation(String), UmaPackage.getArtifactDescription_Notation()

setNotation

void setNotation(java.lang.String value)

Sets the value of the 'Notation' attribute.

Parameters:

value - the new value of the 'Notation' attribute.

See Also:

getNotation()