com.telelogic.rhapsody.core
Interface IRPInterfaceItem

All Superinterfaces:
IRPClassifier, IRPModelElement, IRPUnit
All Known Subinterfaces:
IRPEvent, IRPEventReception, IRPOperation

public interface IRPInterfaceItem
extends IRPClassifier

The IRPInterfaceItem interface represents the features shared by operations, events, and event receptions in Rational Rhapsody models.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPArgument addArgument(java.lang.String newVal)
          Adds a new argument to the end of the argument list.
 IRPArgument addArgumentBeforePosition(java.lang.String newVal, int pos)
          Adds a new argument at the specified position in the argument list.
 IRPCollection getArguments()
          Returns a collection of all the arguments for the operation (collection of IRPArgument objects).
 java.lang.String getSignature()
          Returns the signature of the operation.
 java.lang.String getSignatureNoArgNames()
          Returns the signature of the operation without the argument names.
 java.lang.String getSignatureNoArgTypes()
          Returns the signature of the operation without the argument types.
 int matchOnSignature(IRPInterfaceItem Item)
          Compares the signature of the operation with the signature of the operation that was provided as an argument.
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPClassifier
addActivityDiagram, addAttribute, addFlowItems, addFlows, addGeneralization, addOperation, addRelation, addRelationTo, addStatechart, addUnidirectionalRelation, addUnidirectionalRelationTo, deleteAttribute, deleteFlowItems, deleteFlows, deleteGeneralization, deleteOperation, deleteRelation, findAttribute, findBaseClassifier, findDerivedClassifier, findGeneralization, findInterfaceItem, findNestedClassifier, findNestedClassifierRecursive, findRelation, findTrigger, getActivityDiagram, getAttributes, getAttributesIncludingBases, getBaseClassifiers, getBehavioralDiagrams, getDerivedClassifiers, getFlowItems, getFlows, getGeneralizations, getInterfaceItems, getInterfaceItemsIncludingBases, getLinks, getNestedClassifiers, getOperations, getPorts, getRelations, getRelationsIncludingBases, getSequenceDiagrams, getSourceArtifacts, getStatechart
 
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

addArgument

IRPArgument addArgument(java.lang.String newVal)
Adds a new argument to the end of the argument list. The method takes only a single argument - the name to use for the argument. The type of the argument is set by default to "int". To change the type of the argument, use the method IRPArgument.setType.

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

addArgumentBeforePosition

IRPArgument addArgumentBeforePosition(java.lang.String newVal,
                                      int pos)
Adds a new argument at the specified position in the argument list. Like the addArgument method, the type of the argument is set by default to "int". To change the type of the argument, use the method IRPArgument.setType.

Parameters:
newVal - the name to use for the new argument
pos - the position in the argument list where the new argument should be placed (1 signifies the first argument in the list)
Returns:
the argument that was created

getArguments

IRPCollection getArguments()
Returns a collection of all the arguments for the operation (collection of IRPArgument objects).

Returns:
all the arguments for the operation

getSignature

java.lang.String getSignature()
Returns the signature of the operation.

Returns:
the signature of the operation

getSignatureNoArgNames

java.lang.String getSignatureNoArgNames()
Returns the signature of the operation without the argument names.

Returns:
the signature of the operation without the argument names

getSignatureNoArgTypes

java.lang.String getSignatureNoArgTypes()
Returns the signature of the operation without the argument types.

Returns:
the signature of the operation without the argument types

matchOnSignature

int matchOnSignature(IRPInterfaceItem Item)
Compares the signature of the operation with the signature of the operation that was provided as an argument. This method is useful if you are moving an operation from one class to another because Rhapsody will throw an exception if an operation with the identical signature already exists in the class.

Parameters:
Item - the operation whose signature should be compared to the signature of the current operation
Returns:
1 if the two signatures are identical, 0 otherwise