com.telelogic.rhapsody.core
Interface IRPComponent

All Superinterfaces:
IRPModelElement, IRPUnit

public interface IRPComponent
extends IRPUnit

The IRPComponent interface represents a code generation component defined in a Rhapsody model.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPConfiguration addConfiguration(java.lang.String name)
          Adds a new configuration to the component.
 IRPFile addFile(java.lang.String name)
          Adds a new File to the component.
 IRPFile addFolder(java.lang.String name)
          Adds a new Folder to the component.
 IRPComponent addNestedComponent(java.lang.String name)
          Adds a new nested component to the component.
 void addScopeElement(IRPModelElement pVal)
          Adds the specified model element to the scope of the component.
 void addScopeElementWithoutAggregates(IRPModelElement pVal)
          method addScopeElementWithoutAggregates
 void addToScope(IRPFile file, IRPCollection classes, IRPCollection packages)
          method addToScope
 void allElementsInScope()
          Adds all the elements in the model to the scope of the component.
 void deleteConfiguration(IRPConfiguration configuration)
          Deletes the specified configuration.
 void deleteFile(IRPFile file)
          Deletes the specified File.
 IRPConfiguration findConfiguration(java.lang.String name)
          Returns the configuration with the specified name.
 java.lang.String getAdditionalSources()
          Returns the additional sources defined for the component.
 java.lang.String getBuildType()
          Returns the build type of the component - Library, Executable, or Analysis.
 IRPConfiguration getConfigByDependency(IRPDependency o)
          method getConfigByDependency
 IRPCollection getConfigurations()
          Returns a collection of all the configurations in the component.
 IRPFile getFile(IRPClassifier c, int spec)
          method getFile
 java.lang.String getFileName(IRPClassifier c, int spec, int withExt)
          method getFileName
 IRPCollection getFiles()
          Returns a collection of all the Files in the component.
 java.lang.String getIncludePath()
          Returns the include path defined for the component.
 java.lang.String getLibraries()
          get property libraries
 java.lang.String getModelElementFileName(IRPModelElement c, int spec, int withExt)
          method getModelElementFileName
 IRPCollection getNestedComponents()
          Returns a collection of all the nested components in the component.
 IRPFile getPackageFile(IRPPackage c, int spec)
          method getPackageFile
 IRPCollection getPanelDiagrams()
          Returns a collection of all the panel diagrams in the component.
 java.lang.String getPath(int fullPath)
          get property path
 IRPCollection getPossibleVariants(IRPModelElement variationPoint)
          method getPossibleVariants
 int getScopeBySelectedElements()
          Checks whether the scope of the component has been set to include all elements or only specific elements.
 IRPCollection getScopeElements()
          Returns a collection of all the model elements in the scope of the component.
 IRPCollection getScopeElementsByCategory(java.lang.String category)
          method getScopeElementsByCategory
 java.lang.String getStandardHeaders()
          Returns the standard headers defined for the component.
 IRPModelElement getVariant(IRPModelElement variationPoint)
          method getVariant
 IRPCollection getVariationPoints()
          Returns a collection of the variation points that are included in the scope of the component.
 int isDirectoryPerModelComponent(IRPModelElement o)
          method isDirectoryPerModelComponent
 void removeScopeElement(IRPModelElement pVal)
          Removes the specified model element from the scope of the component.
 void setAdditionalSources(java.lang.String additionalSources)
          Specifies the additional sources to use for the component.
 void setBuildType(java.lang.String buildType)
          Specifies the build type for the component.
 void setIncludePath(java.lang.String includePath)
          Specifies the include path to use for the component.
 void setLibraries(java.lang.String libraries)
          set property libraries
 void setPath(java.lang.String path)
          method setPath
 void setScopeBySelectedElements(int scopeBySelectedElements)
          set toggle the scope between selected and all-elements
 void setStandardHeaders(java.lang.String standardHeaders)
          Specifies the standard headers for the component.
 void setVariant(IRPModelElement variationPoint, IRPModelElement pVariant)
          method setVariant
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPUnit
copyToAnotherProject, getAddToModelMode, getCMHeader, getCMState, getCurrentDirectory, getFilename, getIncludeInNextLoad, getIsStub, getLanguage, getLastModifiedTime, getNestedSaveUnits, getNestedSaveUnitsCount, getStructureDiagrams, isReadOnly, isReferenceUnit, isSeparateSaveUnit, load, moveToAnotherProjectLeaveAReference, referenceToAnotherProject, save, setCMHeader, setFilename, setIncludeInNextLoad, setLanguage, setReadOnly, setSeparateSaveUnit, setUnitPath, unload
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPModelElement
addAssociation, addDependency, addDependencyBetween, addDependencyTo, addLinkToElement, addNewAggr, addProperty, addRedefines, addRemoteDependencyTo, addSpecificStereotype, addStereotype, becomeTemplateInstantiationOf, changeTo, clone, createOSLCLink, deleteDependency, deleteFromProject, deleteOSLCLink, errorMessage, findElementsByFullName, findNestedElement, findNestedElementRecursive, getAllTags, getAnnotations, getAssociationClasses, getBinaryID, getConstraints, getConstraintsByHim, getControlledFiles, getDecorationStyle, getDependencies, getDescription, getDescriptionHTML, getDescriptionPlainText, getDescriptionRTF, getDisplayName, getDisplayNameRTF, getErrorMessage, getFullPathName, getFullPathNameIn, getGUID, getHyperLinks, getIconFileName, getInterfaceName, getIsExternal, getIsOfMetaClass, getIsShowDisplayName, getIsUnresolved, getLocalTags, getMainDiagram, getMetaClass, getName, getNestedElements, getNestedElementsByMetaClass, getNestedElementsRecursive, getNewTermStereotype, getOfTemplate, getOSLCLinks, getOverlayIconFileName, getOverriddenProperties, getOverriddenPropertiesByPattern, getOwnedDependencies, getOwner, getProject, getPropertyValue, getPropertyValueConditional, getPropertyValueConditionalExplicit, getPropertyValueExplicit, getRedefines, getReferences, getRemoteDependencies, getRemoteURI, getRequirementTraceabilityHandle, getSaveUnit, getStereotype, getStereotypes, getTag, getTemplateParameters, getTi, getToolTipHTML, getUserDefinedMetaClass, hasNestedElements, hasPanelWidget, highLightElement, isATemplate, isDescriptionRTF, isDisplayNameRTF, isModified, isRemote, locateInBrowser, lockOnDesignManager, openFeaturesDialog, removeProperty, removeRedefines, removeStereotype, setDecorationStyle, setDescription, setDescriptionAndHyperlinks, setDescriptionHTML, setDescriptionRTF, setDisplayName, setDisplayNameRTF, setGUID, setIsShowDisplayName, setMainDiagram, setName, setOfTemplate, setOwner, setPropertyValue, setRequirementTraceabilityHandle, setStereotype, setTagContextValue, setTagElementValue, setTagValue, setTi, synchronizeTemplateInstantiation, unlockOnDesignManager
 

Method Detail

addConfiguration

IRPConfiguration addConfiguration(java.lang.String name)
Adds a new configuration to the component.

Parameters:
name - the name to use for the new configuration
Returns:
the configuration that was created

addFile

IRPFile addFile(java.lang.String name)
Adds a new File to the component.

Parameters:
name - the name to use for the new File
Returns:
the File that was created

addFolder

IRPFile addFolder(java.lang.String name)
Adds a new Folder to the component.

Parameters:
name - the name to use for the new Folder
Returns:
the Folder that was created

addNestedComponent

IRPComponent addNestedComponent(java.lang.String name)
Adds a new nested component to the component.

Parameters:
name - the name to use for the new component
Returns:
the component that was created

addScopeElement

void addScopeElement(IRPModelElement pVal)
Adds the specified model element to the scope of the component.

Parameters:
pVal - the model element that should be added to the scope of the component

addScopeElementWithoutAggregates

void addScopeElementWithoutAggregates(IRPModelElement pVal)
method addScopeElementWithoutAggregates

Throws:
RhapsodyRuntimeException

addToScope

void addToScope(IRPFile file,
                IRPCollection classes,
                IRPCollection packages)
method addToScope

Throws:
RhapsodyRuntimeException

allElementsInScope

void allElementsInScope()
Adds all the elements in the model to the scope of the component.


deleteConfiguration

void deleteConfiguration(IRPConfiguration configuration)
Deletes the specified configuration.

Parameters:
configuration - the configuration that should be deleted

deleteFile

void deleteFile(IRPFile file)
Deletes the specified File.

Parameters:
file - the File that should be deleted

findConfiguration

IRPConfiguration findConfiguration(java.lang.String name)
Returns the configuration with the specified name.

Parameters:
name - the name of the configuration to return
Returns:
the configuration with the specified name

getAdditionalSources

java.lang.String getAdditionalSources()
Returns the additional sources defined for the component.

Returns:
the additional sources defined for the component

getBuildType

java.lang.String getBuildType()
Returns the build type of the component - Library, Executable, or Analysis.

Returns:
the build type of the component - Library, Executable, or Analysis

getConfigByDependency

IRPConfiguration getConfigByDependency(IRPDependency o)
method getConfigByDependency

Throws:
RhapsodyRuntimeException

getConfigurations

IRPCollection getConfigurations()
Returns a collection of all the configurations in the component.

Returns:
all the configurations in the component

getFile

IRPFile getFile(IRPClassifier c,
                int spec)
method getFile

Throws:
RhapsodyRuntimeException

getFileName

java.lang.String getFileName(IRPClassifier c,
                             int spec,
                             int withExt)
method getFileName

Throws:
RhapsodyRuntimeException

getFiles

IRPCollection getFiles()
Returns a collection of all the Files in the component.

Returns:
all the Files in the component

getIncludePath

java.lang.String getIncludePath()
Returns the include path defined for the component.

Returns:
the include path defined for the component

getLibraries

java.lang.String getLibraries()
get property libraries

Throws:
RhapsodyRuntimeException

getModelElementFileName

java.lang.String getModelElementFileName(IRPModelElement c,
                                         int spec,
                                         int withExt)
method getModelElementFileName

Throws:
RhapsodyRuntimeException

getNestedComponents

IRPCollection getNestedComponents()
Returns a collection of all the nested components in the component.

Returns:
all the nested components in the component

getPackageFile

IRPFile getPackageFile(IRPPackage c,
                       int spec)
method getPackageFile

Throws:
RhapsodyRuntimeException

getPanelDiagrams

IRPCollection getPanelDiagrams()
Returns a collection of all the panel diagrams in the component.

Returns:
all the panel diagrams in the component

getPath

java.lang.String getPath(int fullPath)
get property path

Throws:
RhapsodyRuntimeException

getPossibleVariants

IRPCollection getPossibleVariants(IRPModelElement variationPoint)
method getPossibleVariants

Throws:
RhapsodyRuntimeException

getScopeBySelectedElements

int getScopeBySelectedElements()
Checks whether the scope of the component has been set to include all elements or only specific elements. This corresponds to the All Elements and Selected Elements radio buttons on the Scope tab of the Features dialog for components.

Returns:
1 if the scope has been set to include only specific elements, 0 if the scope has been set to include all elements

getScopeElements

IRPCollection getScopeElements()
Returns a collection of all the model elements in the scope of the component.

Returns:
all the model elements in the scope of the component

getScopeElementsByCategory

IRPCollection getScopeElementsByCategory(java.lang.String category)
method getScopeElementsByCategory

Throws:
RhapsodyRuntimeException

getStandardHeaders

java.lang.String getStandardHeaders()
Returns the standard headers defined for the component.

Returns:
the standard headers defined for the component

getVariant

IRPModelElement getVariant(IRPModelElement variationPoint)
method getVariant

Throws:
RhapsodyRuntimeException

getVariationPoints

IRPCollection getVariationPoints()
Returns a collection of the variation points that are included in the scope of the component. The collection consists of objects of type IRPClass.

Returns:
a collection of the variation points that are included in the scope of the component

isDirectoryPerModelComponent

int isDirectoryPerModelComponent(IRPModelElement o)
method isDirectoryPerModelComponent

Throws:
RhapsodyRuntimeException

removeScopeElement

void removeScopeElement(IRPModelElement pVal)
Removes the specified model element from the scope of the component.

Parameters:
pVal - the model element that should be removed from the scope of the component

setAdditionalSources

void setAdditionalSources(java.lang.String additionalSources)
Specifies the additional sources to use for the component.

Parameters:
additionalSources - the additional sources to use for the component

setBuildType

void setBuildType(java.lang.String buildType)
Specifies the build type for the component.

Parameters:
buildType - the build type that should be used for the component. The valid strings for this parameter are: Executable, Library, and Analysis.

setIncludePath

void setIncludePath(java.lang.String includePath)
Specifies the include path to use for the component.

Parameters:
includePath - the include path to use for the component

setLibraries

void setLibraries(java.lang.String libraries)
set property libraries

Throws:
RhapsodyRuntimeException

setPath

void setPath(java.lang.String path)
method setPath

Throws:
RhapsodyRuntimeException

setScopeBySelectedElements

void setScopeBySelectedElements(int scopeBySelectedElements)
set toggle the scope between selected and all-elements

Throws:
RhapsodyRuntimeException

setStandardHeaders

void setStandardHeaders(java.lang.String standardHeaders)
Specifies the standard headers for the component.

Parameters:
standardHeaders - a string consisting of a comma-separated list of the files that should be used as standard headers for the component

setVariant

void setVariant(IRPModelElement variationPoint,
                IRPModelElement pVariant)
method setVariant

Throws:
RhapsodyRuntimeException