com.telelogic.rhapsody.core
Interface IRPClassifier

All Superinterfaces:
IRPModelElement, IRPUnit
All Known Subinterfaces:
IRPActor, IRPAssociationClass, IRPClass, IRPEvent, IRPEventReception, IRPFlowchart, IRPFlowItem, IRPInterfaceItem, IRPNode, IRPOperation, IRPStatechart, IRPStereotype, IRPType, IRPUseCase

public interface IRPClassifier
extends IRPUnit

Represents the features shared by elements such as classes, actors, use cases, and types.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPFlowchart addActivityDiagram()
          Creates a new activity diagram.
 IRPAttribute addAttribute(java.lang.String name)
          Adds a new attribute to the classifier.
 IRPFlowItem addFlowItems(java.lang.String name)
          Adds a new item flow to the classifier.
 IRPFlow addFlows(java.lang.String name)
          Adds a new flow to the classifier.
 void addGeneralization(IRPClassifier pVal)
          Adds a generalization relationship between the classifier and the classifier specified as a parameter.
 IRPOperation addOperation(java.lang.String name)
          Adds a new operation.
 IRPRelation addRelation(java.lang.String otherClassName, java.lang.String otherClassPackageName, java.lang.String roleName1, java.lang.String linkType1, java.lang.String multiplicity1, java.lang.String roleName2, java.lang.String linkType2, java.lang.String multiplicity2, java.lang.String linkName)
          Adds a new association to the classifier.
 IRPRelation addRelationTo(IRPClassifier otherClassifier, java.lang.String roleName1, java.lang.String linkType1, java.lang.String multiplicity1, java.lang.String roleName2, java.lang.String linkType2, java.lang.String multiplicity2, java.lang.String linkName)
          Adds a new association to the classifier.
 IRPStatechart addStatechart()
          Creates a new statechart.
 IRPRelation addUnidirectionalRelation(java.lang.String otherClassName, java.lang.String otherClassPackageName, java.lang.String roleName, java.lang.String linkType, java.lang.String multiplicity, java.lang.String linkName)
          Adds a new directed association to the classifier.
 IRPRelation addUnidirectionalRelationTo(IRPClassifier otherClassifier, java.lang.String roleName, java.lang.String linkType, java.lang.String multiplicity, java.lang.String linkName)
          Adds a new directed association to the classifier.
 void deleteAttribute(IRPAttribute attribute)
          Deletes the specified attribute.
 void deleteFlowItems(IRPFlowItem pItem)
          Deletes the specified item flow.
 void deleteFlows(IRPFlow pFlow)
          Deletes the specified flow.
 void deleteGeneralization(IRPClassifier superClass)
          Deletes the generalization relationship between the classifier and the classifier specified as a parameter.
 void deleteOperation(IRPOperation operation)
          Deletes the specified operation.
 void deleteRelation(IRPRelation relation)
          Deletes the specified relation.
 IRPAttribute findAttribute(java.lang.String newVal)
          Returns the attribute with the name specified.
 IRPClassifier findBaseClassifier(java.lang.String newVal)
          Returns the base classifier with the specified name.
 IRPClassifier findDerivedClassifier(java.lang.String newVal)
          Returns the derived classifier with the specified name.
 IRPGeneralization findGeneralization(java.lang.String newVal)
          Returns the element representing the generalization relationship between this classifier and the classifier whose name was specified as a parameter.
 IRPInterfaceItem findInterfaceItem(java.lang.String signature)
          Gets the operation or event reception that matches the signature provided.
 IRPClassifier findNestedClassifier(java.lang.String newVal)
          Searches for the nested classifier with the name specified.
 IRPModelElement findNestedClassifierRecursive(java.lang.String newVal)
          Searches recursively for the classifier with the name specified.
 IRPRelation findRelation(java.lang.String newVal)
          Returns the association whose name was specified as a parameter.
 IRPInterfaceItem findTrigger(java.lang.String name)
          Returns the trigger with the specified name in the classifier's statechart.
 IRPFlowchart getActivityDiagram()
          This method should no longer be used because Rational Rhapsody now allows you to define more than one statechart and activity diagram for a class.
 IRPCollection getAttributes()
          Returns a collection of all the classifier's attributes.
 IRPCollection getAttributesIncludingBases()
          Returns a collection of all the classifier's attributes, including those it inherits from its base classifiers.
 IRPCollection getBaseClassifiers()
          Returns a collection of the classifiers that server as base classifiers for this classifier.
 IRPCollection getBehavioralDiagrams()
          Returns a collection of all the statecharts and activities defined for the classifier.
 IRPCollection getDerivedClassifiers()
          Returns a collection of all the classifiers derived from this classifier.
 IRPCollection getFlowItems()
          Returns a collection of all the classifier's item flows.
 IRPCollection getFlows()
          Returns a collection of the classifier's flows.
 IRPCollection getGeneralizations()
          Returns a collection of all the classifier's generalization relationships.
 IRPCollection getInterfaceItems()
          Returns a collection of the classifier's elements of type IRPInterfaceItem (such as operations, triggered operations, and event receptions).
 IRPCollection getInterfaceItemsIncludingBases()
          Returns a collection of the classifier's elements of type IRPInterfaceItem (such as operations, triggered operations, and event receptions), including those it inherits from its base classifier.
 IRPCollection getLinks()
          Returns a collection of all the classifier's link relationships.
 IRPCollection getNestedClassifiers()
          Returns a collection of all the classifiers nested below the current classifier.
 IRPCollection getOperations()
          Returns a collection of all the classifier's operations.
 IRPCollection getPorts()
          Returns a collection of all the classifier's ports.
 IRPCollection getRelations()
          Returns a collection of all the classifier's associations.
 IRPCollection getRelationsIncludingBases()
          Returns a collection of all the classifier's associations, including those it inherits from its base classifier.
 IRPCollection getSequenceDiagrams()
          Returns a collection of the classifier's sequence diagrams.
 IRPCollection getSourceArtifacts()
          Gets the source artifacts for the classifier.
 IRPStatechart getStatechart()
          This method should no longer be used because Rational Rhapsody now allows you to define more than one statechart and activity diagram for a class.
 
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

addActivityDiagram

IRPFlowchart addActivityDiagram()
Creates a new activity diagram.

Returns:
the activity diagram that was created

addAttribute

IRPAttribute addAttribute(java.lang.String name)
Adds a new attribute to the classifier.

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

addFlowItems

IRPFlowItem addFlowItems(java.lang.String name)
Adds a new item flow to the classifier.

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

addFlows

IRPFlow addFlows(java.lang.String name)
Adds a new flow to the classifier.

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

addGeneralization

void addGeneralization(IRPClassifier pVal)
Adds a generalization relationship between the classifier and the classifier specified as a parameter. For example:
 
        convertibleClass.addGeneralization(carClass);
 

Parameters:
pVal - the classifier that should serve as the base classifier for this classifier

addOperation

IRPOperation addOperation(java.lang.String name)
Adds a new operation.

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

addRelation

IRPRelation addRelation(java.lang.String otherClassName,
                        java.lang.String otherClassPackageName,
                        java.lang.String roleName1,
                        java.lang.String linkType1,
                        java.lang.String multiplicity1,
                        java.lang.String roleName2,
                        java.lang.String linkType2,
                        java.lang.String multiplicity2,
                        java.lang.String linkName)
Adds a new association to the classifier.

Parameters:
otherClassName - the name of the classifier that the current classifier should be associated with
otherClassPackageName - that name of the package that contains the classifier that the current classifier should be associated with
roleName1 - the role name to use for the association end near the other classifier
linkType1 - used in conjunction with the parameter linkType2 to determine the type of association to create. The strings that can be used for this parameter are Association, Aggregation and Composition (parameter is case-sensitive). To create a simple association, use Association for each of the linkType parameters. To create an aggregation relationship, use Association for one of the linkType parameters and Aggregation for the other parameter. To create a composition relationship, use Association for one of the linkType parameters and use Composition for the other parameter.
multiplicity1 - the multiplicity to use for the association end near the other classifier. You can use strings such as "1" or "14" to specify a specific number, or you can use one of the values listed in the Features dialog for attributes: "0,1", "*", or "1..*".
roleName2 - the role name to use for the association end near the current classifier
linkType2 - used in conjunction with the parameter linkType1 to determine the type of association to create. The strings that can be used for this parameter are Association, Aggregation and Composition (parameter is case-sensitive). To create a simple association, use Association for each of the linkType parameters. To create an aggregation relationship, use Association for one of the linkType parameters and Aggregation for the other parameter. To create a composition relationship, use Association for one of the linkType parameters and use Composition for the other parameter.
multiplicity2 - the multiplicity to use for the association end near the current classifier. You can use strings such as "1" or "14" to specify a specific number, or you can use one of the values listed in the Features dialog for attributes: "0,1", "*", or "1..*".
linkName - if you want to create an association class, use this parameter to specify the name of the class. If you do not want to create an association class, use an empty string as the value of this parameter.
Returns:
the association that was created

addRelationTo

IRPRelation addRelationTo(IRPClassifier otherClassifier,
                          java.lang.String roleName1,
                          java.lang.String linkType1,
                          java.lang.String multiplicity1,
                          java.lang.String roleName2,
                          java.lang.String linkType2,
                          java.lang.String multiplicity2,
                          java.lang.String linkName)
Adds a new association to the classifier.

Parameters:
otherClassifier - the classifier that the current classifier should be associated with
roleName1 - the role name to use for the association end near the other classifier
linkType1 - used in conjunction with the parameter linkType2 to determine the type of association to create. The strings that can be used for this parameter are Association, Aggregation and Composition (parameter is case-sensitive). To create a simple association, use Association for each of the linkType parameters. To create an aggregation relationship, use Association for one of the linkType parameters and Aggregation for the other parameter. To create a composition relationship, use Association for one of the linkType parameters and use Composition for the other parameter.
multiplicity1 - the multiplicity to use for the association end near the other classifier. You can use strings such as "1" or "14" to specify a specific number, or you can use one of the values listed in the Features dialog for attributes: "0,1", "*", or "1..*".
roleName2 - the role name to use for the association end near the current classifier
linkType2 - used in conjunction with the parameter linkType1 to determine the type of association to create. The strings that can be used for this parameter are Association, Aggregation and Composition (parameter is case-sensitive). To create a simple association, use Association for each of the linkType parameters. To create an aggregation relationship, use Association for one of the linkType parameters and Aggregation for the other parameter. To create a composition relationship, use Association for one of the linkType parameters and use Composition for the other parameter.
multiplicity2 - the multiplicity to use for the association end near the current classifier. You can use strings such as "1" or "14" to specify a specific number, or you can use one of the values listed in the Features dialog for attributes: "0,1", "*", or "1..*".
linkName - if you want to create an association class, use this parameter to specify the name of the class. If you do not want to create an association class, use an empty string as the value of this parameter.
Returns:
the association that was created

addStatechart

IRPStatechart addStatechart()
Creates a new statechart.

Returns:
the statechart that was created

addUnidirectionalRelation

IRPRelation addUnidirectionalRelation(java.lang.String otherClassName,
                                      java.lang.String otherClassPackageName,
                                      java.lang.String roleName,
                                      java.lang.String linkType,
                                      java.lang.String multiplicity,
                                      java.lang.String linkName)
Adds a new directed association to the classifier.

Parameters:
otherClassName - the name of the classifier that the current classifier should be associated with
otherClassPackageName - that name of the package that contains the classifier that the current classifier should be associated with
roleName - the role name to use for the association end
linkType - used to determine the type of association to create. The strings that can be used for this parameter are Association, Aggregation and Composition (parameter is case-sensitive).
multiplicity - the multiplicity to use for the association end. You can use strings such as "1" or "14" to specify a specific number, or you can use one of the values listed in the Features dialog for attributes: "0,1", "*", or "1..*".
linkName - if you want to create an association class, use this parameter to specify the name of the class. If you do not want to create an association class, use an empty string as the value of this parameter.
Returns:
the association that was created

addUnidirectionalRelationTo

IRPRelation addUnidirectionalRelationTo(IRPClassifier otherClassifier,
                                        java.lang.String roleName,
                                        java.lang.String linkType,
                                        java.lang.String multiplicity,
                                        java.lang.String linkName)
Adds a new directed association to the classifier.

Parameters:
otherClassifier - the classifier that the current classifier should be associated with
roleName - the role name to use for the association end
linkType - used to determine the type of association to create. The strings that can be used for this parameter are Association, Aggregation and Composition (parameter is case-sensitive).
multiplicity - the multiplicity to use for the association end. You can use strings such as "1" or "14" to specify a specific number, or you can use one of the values listed in the Features dialog for attributes: "0,1", "*", or "1..*".
linkName - if you want to create an association class, use this parameter to specify the name of the class. If you do not want to create an association class, use an empty string as the value of this parameter.
Returns:
the association that was created

deleteAttribute

void deleteAttribute(IRPAttribute attribute)
Deletes the specified attribute.

Parameters:
attribute - the attribute that should be deleted

deleteFlowItems

void deleteFlowItems(IRPFlowItem pItem)
Deletes the specified item flow.

Parameters:
pItem - the item flow that should be deleted

deleteFlows

void deleteFlows(IRPFlow pFlow)
Deletes the specified flow.

Parameters:
pFlow - the flow that should be deleted

deleteGeneralization

void deleteGeneralization(IRPClassifier superClass)
Deletes the generalization relationship between the classifier and the classifier specified as a parameter.

Parameters:
superClass - the classifier whose generalization relationship with this classifier should be deleted

deleteOperation

void deleteOperation(IRPOperation operation)
Deletes the specified operation.

Parameters:
operation - the operation that should be deleted

deleteRelation

void deleteRelation(IRPRelation relation)
Deletes the specified relation.

Parameters:
relation - the relation that should be deleted

findAttribute

IRPAttribute findAttribute(java.lang.String newVal)
Returns the attribute with the name specified.

Parameters:
newVal - the name of the attribute that should be returned
Returns:
the attribute with the name specified

findBaseClassifier

IRPClassifier findBaseClassifier(java.lang.String newVal)
Returns the base classifier with the specified name.

Parameters:
newVal - the name of the base classifier that should be returned
Returns:
the base classifier with the specified name

findDerivedClassifier

IRPClassifier findDerivedClassifier(java.lang.String newVal)
Returns the derived classifier with the specified name.

Parameters:
newVal - the name of the derived classifier that should be returned
Returns:
the derived classifier with the specified name

findGeneralization

IRPGeneralization findGeneralization(java.lang.String newVal)
Returns the element representing the generalization relationship between this classifier and the classifier whose name was specified as a parameter.

Parameters:
newVal - the name of the classifier whose generalization relationship should be returned
Returns:
the element representing the generalization relationship between this classifier and the classifier whose name was specified as a parameter

findInterfaceItem

IRPInterfaceItem findInterfaceItem(java.lang.String signature)
Gets the operation or event reception that matches the signature provided.

Parameters:
signature - the signature of the operation or event reception. The string you provide should consist of the operation name followed by parentheses containing a comma-delimited list of the types of the parameters, for example, "runEngine(int,int)".
Returns:
the operation or event reception

findNestedClassifier

IRPClassifier findNestedClassifier(java.lang.String newVal)
Searches for the nested classifier with the name specified. This method only searches the first level of elements below the current classifier. To search all of the levels below the current classifier, use the method findNestedClassifierRecursive.

Parameters:
newVal - the name of the classifier to search for
Returns:
the classifier with the name that was specified

findNestedClassifierRecursive

IRPModelElement findNestedClassifierRecursive(java.lang.String newVal)
Searches recursively for the classifier with the name specified. This method searches all of the levels below the current classifier. To search only the first level of elements below the current classifier, use the method findNestedClassifier.

Parameters:
newVal - the name of the classifier to search for
Returns:
the classifier that was specified. Note that the classifier is returned as an object of type IRPModelElement. So you will usually want to use casting, for example: IRPClassifier classifierToSearchFor = (IRPClassifier)stillsCamera.findNestedClassifierRecursive("nested_1_next_level");

findRelation

IRPRelation findRelation(java.lang.String newVal)
Returns the association whose name was specified as a parameter.

Parameters:
newVal - the name of the association that should be returned
Returns:
the association whose name was specified as a parameter

findTrigger

IRPInterfaceItem findTrigger(java.lang.String name)
Returns the trigger with the specified name in the classifier's statechart.

Parameters:
name - the name of the trigger to find
Returns:
the trigger with the specified name in the classifier's statechart

getActivityDiagram

IRPFlowchart getActivityDiagram()
This method should no longer be used because Rational Rhapsody now allows you to define more than one statechart and activity diagram for a class. Use the method getBehavioralDiagrams instead.


getAttributes

IRPCollection getAttributes()
Returns a collection of all the classifier's attributes.

Returns:
all the classifier's attributes

getAttributesIncludingBases

IRPCollection getAttributesIncludingBases()
Returns a collection of all the classifier's attributes, including those it inherits from its base classifiers.

Returns:
all of the classifier's attributes, including those it inherits from its base classifiers

getBaseClassifiers

IRPCollection getBaseClassifiers()
Returns a collection of the classifiers that server as base classifiers for this classifier.

Returns:
all the classifiers that serve as base classifiers for this classifier

getBehavioralDiagrams

IRPCollection getBehavioralDiagrams()
Returns a collection of all the statecharts and activities defined for the classifier. The collection that is returned consists of elements of type IRPStatechart.

Returns:
all of the statecharts and activities defined for the classifier

getDerivedClassifiers

IRPCollection getDerivedClassifiers()
Returns a collection of all the classifiers derived from this classifier.

Returns:
all the classifiers derived from this classifier

getFlowItems

IRPCollection getFlowItems()
Returns a collection of all the classifier's item flows.

Returns:
all of the classifier's item flows

getFlows

IRPCollection getFlows()
Returns a collection of the classifier's flows.

Returns:
all of the classifier's flows

getGeneralizations

IRPCollection getGeneralizations()
Returns a collection of all the classifier's generalization relationships.

Returns:
all of the classifier's generalization relationships

getInterfaceItems

IRPCollection getInterfaceItems()
Returns a collection of the classifier's elements of type IRPInterfaceItem (such as operations, triggered operations, and event receptions).

Returns:
all of the classifier's elements of type IRPInterfaceItem

getInterfaceItemsIncludingBases

IRPCollection getInterfaceItemsIncludingBases()
Returns a collection of the classifier's elements of type IRPInterfaceItem (such as operations, triggered operations, and event receptions), including those it inherits from its base classifier.

Returns:
all of the classifier's elements of type IRPInterfaceItem, including those it inherits from its base classifier

getLinks

IRPCollection getLinks()
Returns a collection of all the classifier's link relationships.

Returns:
all of the classifier's link relationships

getNestedClassifiers

IRPCollection getNestedClassifiers()
Returns a collection of all the classifiers nested below the current classifier. Note that this method is not recursive - it only returns the classifiers at the level directly below the current classifier.

Returns:
all of the classifiers nested below the current classifier

getOperations

IRPCollection getOperations()
Returns a collection of all the classifier's operations.

Returns:
all the classifier's operations

getPorts

IRPCollection getPorts()
Returns a collection of all the classifier's ports.

Returns:
all of the classifier's ports

getRelations

IRPCollection getRelations()
Returns a collection of all the classifier's associations.

Returns:
all of the classifier's associations

getRelationsIncludingBases

IRPCollection getRelationsIncludingBases()
Returns a collection of all the classifier's associations, including those it inherits from its base classifier.

Returns:
all of the classifier's associations, including those it inherits from its base classifier

getSequenceDiagrams

IRPCollection getSequenceDiagrams()
Returns a collection of the classifier's sequence diagrams.

Returns:
all of the classifier's sequence diagrams

getSourceArtifacts

IRPCollection getSourceArtifacts()
Gets the source artifacts for the classifier.

Returns:
the source artifacts for the classifier, as a collection of IRPFile objects

getStatechart

IRPStatechart getStatechart()
This method should no longer be used because Rational Rhapsody now allows you to define more than one statechart and activity diagram for a class. Use the method getBehavioralDiagrams instead.