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
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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionvoidThe file provided is checked-in as the current version of this artifact.checkOut(boolean checkOutForConsolidation) Provides the current version of this artifact.The artifact owning this artifact.intNumber of check-ins.Time of the last check-in.Name of the user who checked-in.Returns the extension contained in the name of this artifact.The modification time of the corresponding file of this artifact.File modification time at time of check-out.File name of this artifact.intFile version at time of check-out.getManifestation(K_CONTROL_OPTION... behaviourFlags) The set of model elements that are manifested in the artifact.intThe time of the last upload of the file of thisCLArtifactto 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.getOwnedOperation(K_CONTROL_OPTION... behaviourFlags) The operations defined for the artifact.Returns the template file configured for the extension of the current object.Returns the name of the working file.booleanA file has been checked-in for this artifact.booleanisTrue, if all utilized elements of this artifact are components.booleanA template file is provided for this artifact's extension and stereotype.booleanThis artifact can import a file.booleanA file has been checked-in for this artifact since the latest check-out.If thisCLArtifactcontains a file anMEAttachmentis created and the file moved from the artifact to the attachment.voidsetFileName(String value) Set the value of Attribut FileName.Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADAccessAble
getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRoleMethods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble
getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDiaMethods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble
getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistoryMethods inherited from interface de.mid.innovator.srv2api.icw2meta.ADLockAble
getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlockMethods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble
getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModifyMethods inherited from interface de.mid.innovator.srv2api.icw2meta.ADOptionAble
getOwnedOption, modifyOptionDlgMethods inherited from interface de.mid.innovator.srv2api.icw2meta.ADReferenceAble
getReferenceContainer, setReferenceContainerMethods inherited from interface de.mid.innovator.srv2api.icw2meta.ADVersionAble
getVersionFile, getVersionList, getVersionListWithoutOpenInfoMethods inherited from interface de.mid.innovator.srv2api.icw2class.CLClassifier
dialogFolderRedefine, getAggregatedClassifier, getAggregatedClassifier, getAggregatedOrComposedClassifier, getAggregatedOrComposedClassifier, getAggregatingClassifier, getAggregatingClassifier, getAggregatingOrComposingClassifier, getAggregatingOrComposingClassifier, getClassifierInstance, getClassifierTemplateParameter, getComposedClassifier, getComposedClassifier, getComposingClassifier, getComposingClassifier, getContract, getContract, getContractSubstitution, 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, getUseCaseMethods inherited from interface de.mid.innovator.srv2api.icw2class.CLDeployedArtifact
getDeployedArtifactMethods inherited from interface de.mid.innovator.srv2api.icw2class.CLTemplateAbleElement
getActualTemplateParameter, getActualTemplateParameter, getOwnedTemplateParameter, getTemplateBindingSource, getTemplateBindingTarget, getTemplateParameterMethods inherited from interface de.mid.innovator.srv2api.icw2class.CLTemplateParameterAbleElement
getActualParameterSubstitution, getOwningTemplateParameter, getTemplateParameterMethods inherited from interface de.mid.innovator.srv2api.icw2elem.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, getItemDefinition, 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, setAbstractMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble
getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContentsMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwnerMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble
deleteMethods inherited from interface de.mid.innovator.srv2api.icw2elem.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, unlockUnitMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELFileAble
getContentMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKindMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAble
getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImportMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble
getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibilityMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject
getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasReadMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELPackageAble
getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackageMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELRedefAble
getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefinedMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELType
getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd, isTypeReuseableMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble
getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUIDMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble
getValueReUseAble, setValueReUseAbleMethods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssignMethods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssignMethods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement
buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColorMethods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement
getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependencyMethods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAble
getMEOwnedMember, getMEPackageImportMethods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble
getMENamespace, getSignatureMessageMethods inherited from interface de.mid.innovator.srv2api.icw2model.MEPackageAble
getComponent, getManifestMethods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble
getApplicableAnalysisDia, getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholderMethods inherited from interface de.mid.innovator.srv2api.icw2model.METermAble
getTerm, setTermMethods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachmentMethods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble
getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConceptMethods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble
getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfoMethods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble
assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, 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, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAbleMethods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble
getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg
-
Method Details
-
getCheckInCount
Number of check-ins.- Throws:
InoNetExceptionSrvErrorException
-
getCheckInTime
Time of the last check-in.- Throws:
InoNetExceptionSrvErrorException
-
getCheckInUser
Name of the user who checked-in.- Throws:
InoNetExceptionSrvErrorException
-
getFileModificationTime
The modification time of the corresponding file of this artifact.- Throws:
InoNetExceptionSrvErrorException
-
getModelSynchronizationTime
The time of the last upload of the file of thisCLArtifactto the model.- Throws:
InoNetExceptionSrvErrorException
-
getFileName
File name of this artifact.- Throws:
InoNetExceptionSrvErrorException
-
setFileName
Set the value of Attribut FileName.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getExtension
Returns the extension contained in the name of this artifact.- Throws:
InoNetExceptionSrvErrorException
-
getFileModificationTimeAtCheckOut
File modification time at time of check-out.- Throws:
InoNetExceptionSrvErrorException
-
getFileVersionAtCheckOut
File version at time of check-out.- Throws:
InoNetExceptionSrvErrorException
-
hasCheckedInFile
A file has been checked-in for this artifact.- Throws:
InoNetExceptionSrvErrorException
-
hasOnlyUtilizedComponent
isTrue, if all utilized elements of this artifact are components.- Throws:
InoNetExceptionSrvErrorException
-
hasTemplateFile
A template file is provided for this artifact's extension and stereotype.- Throws:
InoNetExceptionSrvErrorException
-
isFileAssignAble
This artifact can import a file.- Throws:
InoNetExceptionSrvErrorException
-
isFileVersionNewerThenCheckedOutVersion
A file has been checked-in for this artifact since the latest check-out.- Throws:
InoNetExceptionSrvErrorException
-
getWorkingFileName
Returns the name of the working file.- Throws:
InoNetExceptionSrvErrorException
-
getMaxFileSize
- Throws:
InoNetExceptionSrvErrorException
-
getTemplateFile
Returns the template file configured for the extension of the current object.- Throws:
InoNetExceptionSrvErrorException
-
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:
InoNetExceptionSrvErrorException
-
checkOut
ARG_CheckOutCmd checkOut(boolean checkOutForConsolidation) throws InoNetException, SrvErrorException Provides the current version of this artifact.- Parameters:
checkOutForConsolidation-- Throws:
InoNetExceptionSrvErrorException
-
moveFileToNewAttachment
If thisCLArtifactcontains a file anMEAttachmentis created and the file moved from the artifact to the attachment. The result is the created attachment.- Throws:
InoNetExceptionSrvErrorException
-
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:
InoNetExceptionSrvErrorException- 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:
InoNetExceptionSrvErrorException- 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:
InoNetExceptionSrvErrorException- 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:
InoNetExceptionSrvErrorException- Sorted:
- the result may be sorted.
-
getArtifact
The artifact owning this artifact.- Throws:
InoNetExceptionSrvErrorException
-