Interface CLArtifact

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, CLClassifier, CLDeployedArtifact, CLTemplateAbleElement, CLTemplateParameterAbleElement, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELFileAble, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELRedefAble, ELType, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

All Known Subinterfaces:

CLDeploymentSpec

public interface CLArtifact
extends CLClassifier, ELFileAble, MEPackageAble, CLDeployedArtifact

An artifact is the specification of a physical piece of information that is used or produced by a software development process or by deployment and operation of a system. Examples of artifacts include model files, source files, scripts, binary executable files, a table in a database system, a development deliverable, or a word-processing document, a mail message.

See Also:

• CLArtifactHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CLArtifact.VAttr

Method Summary

Modifier and Type	Method	Description
void	checkIn(ARG_File valFile, boolean overrideNewerServerVersion)	The file provided is checked-in as the current version of this artifact.
ARG_CheckOutCmd	checkOut(boolean checkOutForConsolidation)	Provides the current version of this artifact.
CLArtifact	getArtifact()	The artifact owning this artifact.
int	getCheckInCount()	Number of check-ins.
Date	getCheckInTime()	Time of the last check-in.
String	getCheckInUser()	Name of the user who checked-in.
String	getExtension()	Returns the extension contained in the name of this artifact.
Date	getFileModificationTime()	The modification time of the corresponding file of this artifact.
Date	getFileModificationTimeAtCheckOut()	File modification time at time of check-out.
String	getFileName()	File name of this artifact.
int	getFileVersionAtCheckOut()	File version at time of check-out.
List<CLManifestation>	getManifestation(K_CONTROL_OPTION... behaviourFlags)	The set of model elements that are manifested in the artifact.
int	getMaxFileSize()	The maximum size of files with the extension of this artifact.
Date	getModelSynchronizationTime()	The time of the last upload of the file of this CLArtifact to the model.
<T extends CLArtifact> List<T>	getNestedArtifact(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	The artifacts that are defined (nested) within the artifact.
<T extends CLProperty> List<T>	getOwnedAttribute(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	The attributes or association ends defined for the artifact.
List<CLOperation>	getOwnedOperation(K_CONTROL_OPTION... behaviourFlags)	The operations defined for the artifact.
ARG_File	getTemplateFile()	Returns the template file configured for the extension of the current object.
String	getWorkingFileName()	Returns the name of the working file.
boolean	hasCheckedInFile()	A file has been checked-in for this artifact.
boolean	hasOnlyUtilizedComponent()	isTrue, if all utilized elements of this artifact are components.
boolean	hasTemplateFile()	A template file is provided for this artifact's extension and stereotype.
boolean	isFileAssignAble()	This artifact can import a file.
boolean	isFileVersionNewerThenCheckedOutVersion()	A file has been checked-in for this artifact since the latest check-out.
MEAttachment	moveFileToNewAttachment()	If this CLArtifact contains a file an MEAttachment is created and the file moved from the artifact to the attachment.
void	setFileName(String value)	Set the value of Attribut FileName.

Methods inherited from interface ADAccessAble

getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole

Methods inherited from interface ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface ADLockAble

getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface ADOptionAble

getOwnedOption, modifyOptionDlg

Methods inherited from interface ADReferenceAble

getReferenceContainer, setReferenceContainer

Methods inherited from interface ADVersionAble

getVersionFile, getVersionList, getVersionListWithoutOpenInfo

Methods inherited from interface CLClassifier

dialogFolderRedefine, getAggregatedClassifier, getAggregatedClassifier, getAggregatedOrComposedClassifier, getAggregatedOrComposedClassifier, getAggregatingClassifier, getAggregatingClassifier, getAggregatingOrComposingClassifier, getAggregatingOrComposingClassifier, getClassifierInstance, getClassifierTemplateParameter, getComposedClassifier, getComposedClassifier, getComposingClassifier, getComposingClassifier, getContract, getContract, getCreateObjectAction, getExceptionHandler, getInstSpec, getInterface, getOwnClass, getOwnedRule, getOwnedTemplateParameter, getOwnedUseCase, getProvidedInterface, getProvidedInterface, getProvidedInterfaceDirect, getProvidedInterfaceDirect, getRealizingClassifierRealization, getRequiredInterface, getRequiredInterface, getRequiredInterfaceDirect, getRequiredInterfaceDirect, getSubstitution, getTypedBCProperty, getTypedObjectNode, getTypedParameter, getTypedProperty, getTypedPropertyNotAssocEnd, getTypedVariable, getTypedVariableDRGElement, getTypedVariableDRGElement, getUnmarshallAction, getUseCase

Methods inherited from interface CLDeployedArtifact

getDeployedArtifact

Methods inherited from interface CLTemplateAbleElement

getActualTemplateParameter, getActualTemplateParameter, getOwnedTemplateParameter, getTemplateBindingSource, getTemplateBindingTarget, getTemplateParameter

Methods inherited from interface CLTemplateParameterAbleElement

getActualParameterSubstitution, getTemplateParameter

Methods inherited from interface ELClassifier

getAssociation, getAssociation, getAssociationEndFirstTypedBySelf, getAssociationEndFirstTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelf, getAssociationEndTypedBySelf, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationNavigableFrom, getAssociationNavigableFrom, getAssociationOfSelfOrGeneralTransitive, getAssociationOfSelfOrGeneralTransitive, getAssociationTypedBySelf, getAssociationTypedBySelf, getClassifierViewGroup, getEffectiveRedefinerOfAssocEnd, getEffectiveRedefinerOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getGeneralDirect, getGeneralDirect, getGeneralGeneralizationSet, getGeneralGeneralizationSet, getGeneralization, getGeneralTransitive, getGeneralTransitive, getOwnedAndInheritedMember, getOwnedAndInheritedMember, getPropertyNavigableFrom, getPropertyNavigableFrom, getPropertyNavigableFromSelfOrGeneralTransitive, getPropertyNavigableFromSelfOrGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitiveNotAbstract, getSelfAndSpecificTransitiveNotAbstract, getSpecialization, getSpecificDirect, getSpecificDirect, getSpecificGeneralization, getSpecificGeneralizationSet, getSpecificGeneralizationSet, getSpecificTransitive, getSpecificTransitive, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getTypedCLStructureEntry, getTypedMaskField, getTypesOfEffectiveSubsetterOfAssocEnd, getTypesOfEffectiveSubsetterOfAssocEnd, getViewTransitive, getViewTransitive, isAbstract, isRoot, isSpecificTransitive, setAbstract

Methods inherited from interface ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface ELFileAble

getContent

Methods inherited from interface ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getItemDefinition, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface ELPackageAble

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

Methods inherited from interface ELRedefAble

getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined

Methods inherited from interface ELType

getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd, isTypeReuseable

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface MENamespaceAble

getMEOwnedMember, getMEPackageImport

Methods inherited from interface MENamespaceAsgnAble

getSignatureMessage

Methods inherited from interface MEPackageAble

getComponent, getManifest

Methods inherited from interface MEStereotypeAble

getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface METermAble

getTerm, setTerm

Methods inherited from interface MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

getCheckInCount

int getCheckInCount()
             throws InoNetException,
SrvErrorException

Number of check-ins.

Throws:

InoNetException

SrvErrorException

getCheckInTime

Date getCheckInTime()
             throws InoNetException,
SrvErrorException

Time of the last check-in.

Throws:

InoNetException

SrvErrorException

getCheckInUser

String getCheckInUser()
               throws InoNetException,
SrvErrorException

Name of the user who checked-in.

Throws:

InoNetException

SrvErrorException

getFileModificationTime

Date getFileModificationTime()
                      throws InoNetException,
SrvErrorException

The modification time of the corresponding file of this artifact.

Throws:

InoNetException

SrvErrorException

getModelSynchronizationTime

Date getModelSynchronizationTime()
                          throws InoNetException,
SrvErrorException

The time of the last upload of the file of this CLArtifact to the model.

Throws:

InoNetException

SrvErrorException

getFileName

String getFileName()
            throws InoNetException,
SrvErrorException

File name of this artifact.

Throws:

InoNetException

SrvErrorException

setFileName

void setFileName(String value)
          throws InoNetException,
SrvErrorException

Set the value of Attribut FileName.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getExtension

String getExtension()
             throws InoNetException,
SrvErrorException

Returns the extension contained in the name of this artifact.

Throws:

InoNetException

SrvErrorException

getFileModificationTimeAtCheckOut

Date getFileModificationTimeAtCheckOut()
                                throws InoNetException,
SrvErrorException

File modification time at time of check-out.

Throws:

InoNetException

SrvErrorException

getFileVersionAtCheckOut

int getFileVersionAtCheckOut()
                      throws InoNetException,
SrvErrorException

File version at time of check-out.

Throws:

InoNetException

SrvErrorException

hasCheckedInFile

boolean hasCheckedInFile()
                  throws InoNetException,
SrvErrorException

A file has been checked-in for this artifact.

Throws:

InoNetException

SrvErrorException

hasOnlyUtilizedComponent

boolean hasOnlyUtilizedComponent()
                          throws InoNetException,
SrvErrorException

isTrue, if all utilized elements of this artifact are components.

Throws:

InoNetException

SrvErrorException

hasTemplateFile

boolean hasTemplateFile()
                 throws InoNetException,
SrvErrorException

A template file is provided for this artifact's extension and stereotype.

Throws:

InoNetException

SrvErrorException

isFileAssignAble

boolean isFileAssignAble()
                  throws InoNetException,
SrvErrorException

This artifact can import a file.

Throws:

InoNetException

SrvErrorException

isFileVersionNewerThenCheckedOutVersion

boolean isFileVersionNewerThenCheckedOutVersion()
                                         throws InoNetException,
SrvErrorException

A file has been checked-in for this artifact since the latest check-out.

Throws:

InoNetException

SrvErrorException

getWorkingFileName

String getWorkingFileName()
                   throws InoNetException,
SrvErrorException

Returns the name of the working file.

Throws:

InoNetException

SrvErrorException

getMaxFileSize

int getMaxFileSize()
            throws InoNetException,
SrvErrorException

The maximum size of files with the extension of this artifact.

Throws:

InoNetException

SrvErrorException

getTemplateFile

ARG_File getTemplateFile()
                  throws InoNetException,
SrvErrorException

Returns the template file configured for the extension of the current object.

Throws:

InoNetException

SrvErrorException

checkIn

void checkIn(ARG_File valFile,
 boolean overrideNewerServerVersion)
      throws InoNetException,
SrvErrorException

The file provided is checked-in as the current version of this artifact.

Parameters:

valFile -

overrideNewerServerVersion -

Throws:

InoNetException

SrvErrorException

checkOut

ARG_CheckOutCmd checkOut(boolean checkOutForConsolidation)
                  throws InoNetException,
SrvErrorException

Provides the current version of this artifact.

Parameters:

checkOutForConsolidation -

Throws:

InoNetException

SrvErrorException

moveFileToNewAttachment

MEAttachment moveFileToNewAttachment()
                              throws InoNetException,
SrvErrorException

If this CLArtifact contains a file an MEAttachment is created and the file moved from the artifact to the attachment. The result is the created attachment.

Throws:

InoNetException

SrvErrorException

getManifestation

List<CLManifestation> getManifestation(K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
SrvErrorException

The set of model elements that are manifested in the artifact. These model elements are utilized in the construction (or generation) of the artifact.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getOwnedAttribute

<T extends CLProperty> List<T> getOwnedAttribute(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                          throws InoNetException,
SrvErrorException

The attributes or association ends defined for the artifact.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may sorted.

getOwnedOperation

List<CLOperation> getOwnedOperation(K_CONTROL_OPTION... behaviourFlags)
                             throws InoNetException,
SrvErrorException

The operations defined for the artifact.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getNestedArtifact

<T extends CLArtifact> List<T> getNestedArtifact(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                          throws InoNetException,
SrvErrorException

The artifacts that are defined (nested) within the artifact.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getArtifact

CLArtifact getArtifact()
                throws InoNetException,
SrvErrorException

The artifact owning this artifact.

Throws:

InoNetException

SrvErrorException