com.telelogic.rhapsody.core
Interface IRPTableView

All Superinterfaces:
IRPModelElement, IRPUnit

public interface IRPTableView
extends IRPUnit

The IRPTableView interface represents Table View elements in Rhapsody models.


Nested Class Summary
static class IRPTableView.ContentFormat
          This class contains values that specify export format
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 java.lang.String getContent(java.lang.String format)
          Retrieves the content of the table in the specified format.
 java.lang.String getHTMLContent()
          Returns the content of the table as HTML.
 IRPCollection getImageCollection(java.lang.String sFolder, java.lang.String sFilename, java.lang.String sExtension)
          method GetImageCollection
 int getIncludeDescendants()
          get property includeDescendants
 IRPTableLayout getItsTableLayout()
          method GetItsTableLayout
 IRPCollection getScope()
          method GetScope
 void open()
          method open
 void setIncludeDescendants(int includeDescendants)
          set property includeDescendants
 void setItsTableLayout(IRPTableLayout pVal)
          Specifies the table layout to use for this table view.
 void setScope(IRPCollection pCollection)
          Specifies the scope to use for this table view.
 
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

getContent

java.lang.String getContent(java.lang.String format)
Retrieves the content of the table in the specified format. The value of the parameter should be one of the values defined in the class IRPTableView.ContentFormat. Note that when you call this method, the table is also displayed in Rhapsody.

Parameters:
format - one of the formats defined in the class IRPTableView.ContentFormat, for example, IRPTableView.ContentFormat.CSV
Returns:
the content of the table in the specified format

getHTMLContent

java.lang.String getHTMLContent()
Returns the content of the table as HTML. The content returned begins and ends with the "table" tag. Note that when this method is called, the table is opened in Rational Rhapsody before the HTML is returned.

Returns:
the content of the table as HTML

getImageCollection

IRPCollection getImageCollection(java.lang.String sFolder,
                                 java.lang.String sFilename,
                                 java.lang.String sExtension)
method GetImageCollection

Throws:
RhapsodyRuntimeException

getItsTableLayout

IRPTableLayout getItsTableLayout()
method GetItsTableLayout

Throws:
RhapsodyRuntimeException

getScope

IRPCollection getScope()
method GetScope

Throws:
RhapsodyRuntimeException

setItsTableLayout

void setItsTableLayout(IRPTableLayout pVal)
Specifies the table layout to use for this table view.

Parameters:
pVal - the table layout to use for this table view

setScope

void setScope(IRPCollection pCollection)
Specifies the scope to use for this table view.

Parameters:
pCollection - the scope to use for this table view. Note that the parameter is a Rhapsody collection, but at the moment, only the first value in the collection is used for the scope.

getIncludeDescendants

int getIncludeDescendants()
get property includeDescendants

Throws:
RhapsodyRuntimeException

open

void open()
method open

Throws:
RhapsodyRuntimeException

setIncludeDescendants

void setIncludeDescendants(int includeDescendants)
set property includeDescendants

Throws:
RhapsodyRuntimeException