### getExamplesDirectory Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the directory where examples are located. This is part of the Application Environment configuration. ```APIDOC ## getExamplesDirectory ### Description Gets directory of examples. ### Method Method ### Endpoint N/A (SDK Method) ### Parameters None ### Response - **Examples Directory Path** (String) - The path to the examples directory. ``` -------------------------------- ### getStartWebServerProperty() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Method in class com.nomagic.magicdraw.simulation.SimulationProfile.SimulationConfigStereotype to get the start web server property. ```APIDOC ## getStartWebServerProperty() ### Description Gets the property indicating whether the web server should start for a simulation configuration. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **property** (boolean/object) - The property indicating if the web server should start. ``` -------------------------------- ### getStartTime(Element) Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Method in class com.nomagic.magicdraw.simulation.SimulationProfile.SimulationConfigStereotype to get the start time. ```APIDOC ## getStartTime(Element element) ### Description Gets the start time for a simulation configuration. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters #### Path Parameters - **element** (Element) - Required - The element representing the simulation configuration. ### Request Example N/A ### Response #### Success Response - **startTime** (object/time type) - The start time of the simulation configuration. ``` -------------------------------- ### getStartTimeProperty() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Method in class com.nomagic.magicdraw.simulation.SimulationProfile.SimulationConfigStereotype to get the start time property. ```APIDOC ## getStartTimeProperty() ### Description Gets the property related to the start time for a simulation configuration. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **property** (object/type) - The property related to the start time. ``` -------------------------------- ### getUIInstaller Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Retrieves the UI installer from the MainFrame. ```APIDOC ## getUIInstaller() ### Description Retrieves the UI installer from the MainFrame. ### Method Not specified (likely a method call in a Java API) ``` -------------------------------- ### getPluginDirectory Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the installation directory of a plugin. ```APIDOC ## getPluginDirectory() ### Description Returns the installation directory path for a plugin. This method is available in `PythonPluginDescriptor` and `PluginDescriptor`. ### Method This is a method call within Java. ### Endpoint N/A (Java method) ### Parameters None. ### Response A string representing the plugin's installation directory. ``` -------------------------------- ### getMountPointsFor Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets mount points for a given project. ```APIDOC ## getMountPointsFor ### Description Gets mount points for a given project, i.e. ### Method Static method ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### getSetupPart Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the value of the '_Setup Part_ ' reference list. ```APIDOC ## getSetupPart ### Description Returns the value of the '_Setup Part_ ' reference list for a `LoopNode`. ### Method (Not specified, likely a getter method) ### Endpoint (Not applicable, this is a Java method) ### Parameters (Not specified) ### Request Example (Not applicable) ### Response (Not specified, likely returns a list of setup parts) ``` -------------------------------- ### getMountPoints Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets all mount points in a given project. ```APIDOC ## getMountPoints ### Description Gets all mount points in a given project. ### Method Static method ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### getActivationInstructions() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns plugin activation instructions. ```APIDOC ## getActivationInstructions() ### Description Returns plugin activation instructions. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **String** - The plugin activation instructions. ``` -------------------------------- ### BPMN2Profile Methods Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Provides methods for interacting with BPMN 2.0 profiles, including getting stereotypes for multiple start and throw intermediate events. ```APIDOC ## getInstance(element).multipleStartEvent().getStereotype() ### Description Retrieves the stereotype for a multiple start event associated with a given element. ### Method Not specified (likely a Java method call) ### Endpoint Not applicable ## getMultipleThrowIntermediateEvent() ### Description Deprecated method to get multiple throw intermediate events. Use `getInstance(element).multipleThrowIntermediateEvent().getStereotype()` instead. ### Method Not specified (likely a Java method call) ### Endpoint Not applicable ``` -------------------------------- ### getOccurrenceSpecification__executionSpecificationOfStart() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the reference list '_execution Specification Of Start_'. ```APIDOC ## getOccurrenceSpecification__executionSpecificationOfStart() ### Description Returns the meta object for the reference list '_execution Specification Of Start_'. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### UAF and UnlimitedNatural Methods Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Deprecated method for getting natural resources and method for getting natural value from UnlimitedNatural. ```APIDOC ## UAF and UnlimitedNatural ### getNaturalResource Deprecated. use getInstance(element).naturalResource().getStereotype() ```java Stereotype getNaturalResource() ``` ### getNaturalValue get naturalValue. ```java int getNaturalValue() ``` ``` -------------------------------- ### getUI Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Retrieves the UI configuration for a simulation. ```APIDOC ## getUI(Element) ### Description Gets the UI configuration for a simulation associated with a given element. ### Method Not specified (likely a method call in a Java API) ### Parameters - **Element** (Element) - The element associated with the simulation configuration. ``` -------------------------------- ### Get Version of Attached Project (Helper) Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the version number of a specified attached project. This is a static method in ProjectModuleHelper. ```APIDOC ## getVersion(IAttachedProject attachedProject) ### Description Get version number of specified attached project. ### Method N/A (Method call) ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters - **attachedProject** (IAttachedProject) - Required - The attached project for which to get the version. ### Request Example N/A ### Response - **version** (string) - The version number of the attached project. ``` -------------------------------- ### getInterfaceRealization (UMLPackage) Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for class '`_Interface Realization_`'. This method is part of the UMLPackage interface. ```APIDOC ## getInterfaceRealization() ### Description Returns the meta object for class '`_Interface Realization_`'. ### Method N/A (Method signature provided) ### Endpoint N/A (Method signature provided) ### Parameters None explicitly listed for this method signature. ### Response Returns the meta object for class '`_Interface Realization_`'. ``` -------------------------------- ### Get Current Version of Project Module (ProjectTool) Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the current version of a project module. This method is part of the ProjectTool class. ```APIDOC ## getVersion(ProjectModule projectModule) ### Description Get current version of project module. ### Method N/A (Method call) ### Endpoint N/A ### Parameters - **projectModule** (ProjectModule) - Required - The project module. ### Request Example N/A ### Response - **version** (string) - The current version of the project module. ``` -------------------------------- ### Get Current Version of Attached Project (ProjectTool) Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the current version of an attached project. This method is part of the ProjectTool class. ```APIDOC ## getVersion(IAttachedProject attachedProject) ### Description Get current version of attached project. ### Method N/A (Method call) ### Endpoint N/A ### Parameters - **attachedProject** (IAttachedProject) - Required - The attached project. ### Request Example N/A ### Response - **version** (string) - The current version of the attached project. ``` -------------------------------- ### getSlot_OwningInstance Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the container reference '`_Owning Instance_`' within the UMLPackage. ```APIDOC ## getSlot_OwningInstance() ### Description Returns the meta object for the container reference '`_Owning Instance_`'. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Response - **Meta Object**: The meta object for the Owning Instance container reference. ``` -------------------------------- ### UAF Get Version of Configuration Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Deprecated method to get the version of configuration. Use getInstance(element).versionOfConfiguration().getStereotype() instead. This method is part of the UAF class. ```APIDOC ## getVersionOfConfiguration() ### Description Deprecated. use getInstance(element).versionOfConfiguration().getStereotype() ### Method N/A (Method call) ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response - **configurationVersion** (object) - The version of the configuration. ``` -------------------------------- ### UAF Get Versioned Element Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Deprecated method to get the versioned element. Use getInstance(element).versionedElement().getStereotype() instead. This method is part of the UAF class. ```APIDOC ## getVersionedElement() ### Description Deprecated. use getInstance(element).versionedElement().getStereotype() ### Method N/A (Method call) ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response - **versionedElement** (object) - The versioned element. ``` -------------------------------- ### ProjectOptions - Layout Before Full Screen Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Methods to retrieve layout information before entering or exiting full screen mode. ```APIDOC ## getLayoutBeforeExitFullScreen() ### Description Retrieves the layout information before exiting full screen mode. ### Method Method ### Response #### Success Response (200) - **Layout** (object) - The layout before exiting full screen. ``` ```APIDOC ## getLayoutBeforeFullScreen() ### Description Retrieves the layout information before entering full screen mode. ### Method Method ### Response #### Success Response (200) - **Layout** (object) - The layout before entering full screen. ``` -------------------------------- ### getPropertiesProperty Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the properties property. ```APIDOC ## getPropertiesProperty() ### Description Gets the properties property. ### Method N/A (Method signature provided) ### Endpoint N/A ``` -------------------------------- ### getReception Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the class 'Reception' within the UMLPackage. ```APIDOC ## getReception ### Description Returns the meta object for class '`_Reception_`'. ### Method N/A (Method signature provided) ### Endpoint N/A (Method signature provided) ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### getOnEdgePosition() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the position on the edge. ```APIDOC ## getOnEdgePosition() ### Description Gets the position on the edge. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### getOnClickProperty() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the on-click property. ```APIDOC ## getOnClickProperty() ### Description Gets the on-click property. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Diagram Context Actions and Configuration Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Methods for retrieving context-aware actions and configuration for diagrams. ```APIDOC ## getDiagramContextActions(String, AbstractDiagramPresentationElement, PresentationElement[], PresentationElement) ### Description Returns context AM for given diagram type. ### Method GET ### Endpoint N/A (Java Method) ## getDiagramContextActions(String, DiagramPresentationElement, PresentationElement[], PresentationElement) ### Description Returns context AM for given diagram type. ### Method GET ### Endpoint N/A (Java Method) ## getDiagramContextConfigurator() ### Description Retrieves the diagram context configurator. ### Method GET ### Endpoint N/A (Java Method) ## getDiagramContextConfigurator() ### Description Diagram has no popup menu. ### Method GET ### Endpoint N/A (Java Method) ## getDiagramContextToolbarActions(String, PresentationElement) ### Description Returns context AM for given diagram type. ### Method GET ### Endpoint N/A (Java Method) ``` -------------------------------- ### getActiveElements() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets active elements. ```APIDOC ## getActiveElements() ### Description Gets active elements. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **List** - A list of active elements. ``` -------------------------------- ### getInitialNode Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the class '_**Initial Node**_'. This method is part of the UMLPackage interface. ```APIDOC ## getInitialNode() ### Description Returns the meta object for class '`_Initial Node_`'. ### Method Method ### Endpoint N/A (Java Method) ``` -------------------------------- ### getActiveBrowser() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the active browser. ```APIDOC ## getActiveBrowser() ### Description Gets the active browser. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **Browser** - The active browser. ``` -------------------------------- ### getActive() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the active state. ```APIDOC ## getActive() ### Description Gets the active state. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **boolean** - True if active, false otherwise. ``` -------------------------------- ### getInterface__interfaceRealizationOfContract Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the reference list '`_interface Realization Of Contract_`'. This method is part of the UMLPackage interface. ```APIDOC ## getInterface__interfaceRealizationOfContract() ### Description Returns the meta object for the reference list '`_interface Realization Of Contract_`'. ### Method N/A (Method signature provided) ### Endpoint N/A (Method signature provided) ### Parameters None explicitly listed for this method signature. ### Response Returns the meta object for the specified reference list. ``` -------------------------------- ### getTypeString Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the MOF type as a string. ```APIDOC ## getTypeString(boolean) ### Description Gets the MOF type as a string, with the boolean parameter likely controlling some aspect of the representation. ### Method Not specified (likely a method call in a Java API) ### Parameters - **boolean** (boolean) - A flag to control the type string representation. ``` -------------------------------- ### getKeystore Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html This method is part of the ConnectionInfo class. ```APIDOC ## getKeystore ### Description This method is part of the ConnectionInfo class. ### Method (Not specified in source, assumed to be a getter method) ### Endpoint (Not applicable, this is an SDK method) ### Parameters #### Path Parameters (None specified) #### Query Parameters (None specified) #### Request Body (None specified) ### Request Example (None specified) ### Response #### Success Response (No specific return type or description provided in source) #### Response Example (None specified) ``` -------------------------------- ### getConstraint_OwningTransition Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Retrieves the meta object for the reference '_Owning Transition_'. This method is part of the UMLPackage interface. ```APIDOC ## getConstraint_OwningTransition() ### Description Returns the meta object for the reference '_Owning Transition_'. ### Method N/A (Method Signature) ### Endpoint N/A (Interface Method) ### Parameters None ### Response - meta object for '_Owning Transition_' ``` -------------------------------- ### getStereotypePropertyValue Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets tagged values as a list. ```APIDOC ## getStereotypePropertyValue(Element, Property) ### Description Gets tagged values as a list. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **Property** (Property) - The property representing the tagged value. ### Class com.nomagic.uml2.ext.jmi.helpers.TagsHelper ``` ```APIDOC ## getStereotypePropertyValue(Element, Property, boolean) ### Description Gets tagged values as a list. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **Property** (Property) - The property representing the tagged value. - **boolean** (boolean) - A flag indicating whether to search recursively (behavior not fully specified in source). ### Class com.nomagic.uml2.ext.jmi.helpers.TagsHelper ``` ```APIDOC ## getStereotypePropertyValue(Element, Stereotype, Property) ### Description Gets tagged values as a list. This is a deprecated method. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **Stereotype** (Stereotype) - The stereotype. - **Property** (Property) - The property representing the tagged value. ### Class com.nomagic.uml2.ext.jmi.helpers.DeprecatedStereotypesHelper ### Deprecated Use `TagsHelper.getStereotypePropertyValue(Element, Property)` instead. ``` ```APIDOC ## getStereotypePropertyValue(Element, Stereotype, Property, boolean) ### Description Gets tagged values as a list. This is a deprecated method. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **Stereotype** (Stereotype) - The stereotype. - **Property** (Property) - The property representing the tagged value. - **boolean** (boolean) - A flag indicating whether to search recursively (behavior not fully specified in source). ### Class com.nomagic.uml2.ext.jmi.helpers.DeprecatedStereotypesHelper ### Deprecated Use `TagsHelper.getStereotypePropertyValue(Element, Property, boolean)` instead. ``` ```APIDOC ## getStereotypePropertyValue(Element, Stereotype, String) ### Description Gets tagged values as a list. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **Stereotype** (Stereotype) - The stereotype. - **String** (String) - The name of the tagged value property. ### Class com.nomagic.uml2.ext.jmi.helpers.TagsHelper ``` ```APIDOC ## getStereotypePropertyValue(Element, Stereotype, String, boolean) ### Description Gets tagged values as a list. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **Stereotype** (Stereotype) - The stereotype. - **String** (String) - The name of the tagged value property. - **boolean** (boolean) - A flag indicating whether to search recursively (behavior not fully specified in source). ### Class com.nomagic.uml2.ext.jmi.helpers.TagsHelper ``` ```APIDOC ## getStereotypePropertyValue(Element, String, String) ### Description Gets tagged values as a list. This is a deprecated method. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **String** (String) - The name of the stereotype. - **String** (String) - The name of the tagged value property. ### Class com.nomagic.uml2.ext.jmi.helpers.DeprecatedTagsHelper ### Deprecated Use `TagsHelper.getStereotypePropertyValue(Element, Stereotype, String)` instead. ``` ```APIDOC ## getStereotypePropertyValue(Element, String, String, boolean) ### Description Gets tagged values as a list. This is a deprecated method. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **String** (String) - The name of the stereotype. - **String** (String) - The name of the tagged value property. - **boolean** (boolean) - A flag indicating whether to search recursively (behavior not fully specified in source). ### Class com.nomagic.uml2.ext.jmi.helpers.DeprecatedTagsHelper ### Deprecated Use `TagsHelper.getStereotypePropertyValue(Element, Stereotype, String, boolean)` instead. ``` -------------------------------- ### getStartupDiagram(Element) Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Method in class com.nomagic.magicdraw.simulation.SimulationProfile.SimulationConfigStereotype to get the startup diagram. ```APIDOC ## getStartupDiagram(Element element) ### Description Gets the startup diagram associated with a simulation configuration. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters #### Path Parameters - **element** (Element) - Required - The element representing the simulation configuration. ### Request Example N/A ### Response #### Success Response - **diagram** (Element/Diagram) - The startup diagram. ``` -------------------------------- ### getPreferredSize Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the preferred size for a SelectElementDlg. ```APIDOC ## getPreferredSize (SelectElementDlg) ### Description Gets the preferred size. ### Method Method ### Endpoint com.nomagic.magicdraw.ui.dialogs.SelectElementDlg ``` -------------------------------- ### getStartQuantityProperty() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html This method is available across multiple task stereotypes within the BPMN2Profile, including ManualTask, ReceiveTask, ScriptTask, SendTask, ServiceTask, SubProcess, Task, Transaction, and UserTask. It likely retrieves a property related to the start quantity. ```APIDOC ## getStartQuantityProperty() ### Description Retrieves a property related to the start quantity for various task types. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **property** (object/type) - The property related to the start quantity. ``` -------------------------------- ### getOnEdgeCornerDistance() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the distance from the corner when on an edge. ```APIDOC ## getOnEdgeCornerDistance() ### Description Gets the distance from the corner when on an edge. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### getName() - com.nomagic.magicdraw.usecasescenarios.scenarios.ScenarioNode Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the name of the node. ```APIDOC ## getName() ### Description Gets name of the node. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Response - **nodeName** (string) - The name of the scenario node. ``` -------------------------------- ### getConstraint__behaviorOfPrecondition Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Retrieves the meta object for the reference '_behavior Of Precondition_'. This method is part of the UMLPackage interface. ```APIDOC ## getConstraint__behaviorOfPrecondition() ### Description Returns the meta object for the reference '_behavior Of Precondition_'. ### Method N/A (Method Signature) ### Endpoint N/A (Interface Method) ### Parameters None ### Response - meta object for '_behavior Of Precondition_' ``` -------------------------------- ### getName() - com.nomagic.magicdraw.uml.ConvertElementInfo Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the name of a conversion. ```APIDOC ## getName() ### Description Gets name of conversion. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Response - **conversionName** (string) - The name of the conversion. ``` -------------------------------- ### getStringToPackagePermissionsMap_Key() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the attribute '`_Key_`'. This method is defined in the SecurityPackage interface. ```APIDOC ## getStringToPackagePermissionsMap_Key() ### Description Returns the meta object for the attribute '`_Key_`'. ### Method N/A (Method Signature) ### Endpoint N/A (Method Signature) ### Parameters None ### Response Returns the meta object for the attribute '`_Key_`'. ``` -------------------------------- ### getDeploymentSpecification Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the class 'Deployment Specification'. This method is part of the UMLPackage interface. ```APIDOC ## getDeploymentSpecification() ### Description Returns the meta object for class 'Deployment Specification'. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### getName() - com.nomagic.magicdraw.teamwork2.esi.CategoryInfo Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the name of a category. ```APIDOC ## getName() ### Description Gets category name. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Response - **categoryName** (string) - The name of the category. ``` -------------------------------- ### getStartupDiagramProperty() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Method in class com.nomagic.magicdraw.simulation.SimulationProfile.SimulationConfigStereotype to get the startup diagram property. ```APIDOC ## getStartupDiagramProperty() ### Description Gets the property related to the startup diagram for a simulation configuration. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **property** (object/type) - The property related to the startup diagram. ``` -------------------------------- ### getMountPointID Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the ID of the mount point. ```APIDOC ## getMountPointID ### Description Gets the ID of the mount point. ### Method N/A (Method signature provided) ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### getServerModule(boolean) Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Retrieves a list of all used server modules in the project. ```APIDOC ## getServerModule(boolean) ### Description Get list of used server modules in the project. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters * **boolean** (boolean) - Description of the boolean parameter is not provided in the source. ### Request Example N/A ### Response N/A ``` -------------------------------- ### getManipulationPreferredDimension Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the preferred dimension for manipulation. ```APIDOC ## getManipulationPreferredDimension() ### Description Gets the preferred dimension for manipulation. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Response - The preferred dimension for manipulation. ### Response Example N/A ``` -------------------------------- ### getBehavior__transitionOfEffect Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the container reference '`_transition Of Effect_`'. This method is part of the UMLPackage interface. ```APIDOC ## getBehavior__transitionOfEffect ### Description Returns the meta object for the container reference '`_transition Of Effect_`'. ### Method N/A (Java method signature) ### Endpoint N/A (Java method signature) ### Parameters None ### Request Example None ### Response #### Success Response - **meta object**: The meta object for the specified container reference. ``` -------------------------------- ### getForkNodeClass Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the ForkNode class from the ElementsFactory. ```APIDOC ## getForkNodeClass ### Description Gets the ForkNode class from the ElementsFactory. ### Method N/A (Method signature provided) ### Endpoint N/A (SDK method) ### Parameters N/A (Method signature provided) ### Request Example N/A ### Response N/A ``` -------------------------------- ### getBehavior_Precondition Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the reference list '`_Precondition_`'. This method is part of the UMLPackage interface. ```APIDOC ## getBehavior_Precondition ### Description Returns the meta object for the reference list '`_Precondition_`'. ### Method N/A (Java method signature) ### Endpoint N/A (Java method signature) ### Parameters None ### Request Example None ### Response #### Success Response - **meta object**: The meta object for the specified reference list. ``` -------------------------------- ### getFontHeight Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the font height of a PresentationElement. ```APIDOC ## getFontHeight ### Description Gets the font height of a PresentationElement. ### Method N/A (Method signature provided) ### Endpoint N/A (SDK method) ### Parameters N/A (Method signature provided) ### Request Example N/A ### Response N/A ``` -------------------------------- ### getActiveTree() - DefaultBrowserAction Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the active tree. ```APIDOC ## getActiveTree() ### Description Gets the active tree. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **Tree** - The active tree. ``` -------------------------------- ### Project Tool Version List (Server Project) Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns a list of project version information from an opened server project. This method is part of the ProjectTool class. ```APIDOC ## getVersionList() ### Description Return a list of project version information from opened server project. ### Method N/A (Method call) ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response - **versionList** (array) - A list of project version information. ``` -------------------------------- ### getActiveTabProperty() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the active tab property. ```APIDOC ## getActiveTabProperty() ### Description Gets the active tab property. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **Property** - The active tab property. ``` -------------------------------- ### getBehavior__stateOfEntry Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the container reference '`_state Of Entry_`'. This method is part of the UMLPackage interface. ```APIDOC ## getBehavior__stateOfEntry ### Description Returns the meta object for the container reference '`_state Of Entry_`'. ### Method N/A (Java method signature) ### Endpoint N/A (Java method signature) ### Parameters None ### Request Example None ### Response #### Success Response - **meta object**: The meta object for the specified container reference. ``` -------------------------------- ### getActiveStateImages() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets active state images. ```APIDOC ## getActiveStateImages() ### Description Gets active state images. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **List** - A list of active state images. ``` -------------------------------- ### getProtocolStateMachine_Conformance Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the containment reference list 'Conformance'. ```APIDOC ## getProtocolStateMachine_Conformance ### Description Returns the meta object for the containment reference list 'Conformance'. ### Method Not specified (likely a getter method) ### Endpoint Not applicable (Java method) ### Parameters None explicitly listed in the source. ### Response Not specified. ``` -------------------------------- ### getActiveElementProperty() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the active element property. ```APIDOC ## getActiveElementProperty() ### Description Gets the active element property. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **Property** - The active element property. ``` -------------------------------- ### getActivationCountProperty() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the activation count property. ```APIDOC ## getActivationCountProperty() ### Description Gets the activation count property. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **Property** - The activation count property. ``` -------------------------------- ### getSubstitution Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Retrieves the meta object for the class '_Substitution_'. This method is part of the UMLPackage interface. ```APIDOC ## getSubstitution (UMLPackage) ### Description Returns the meta object for class '`_Substitution_`'. ### Method Method ### Endpoint N/A ### Parameters None explicitly defined in source. ### Request Example None provided. ### Response #### Success Response Returns the meta object for class '`_Substitution_`'. #### Response Example None provided. ``` -------------------------------- ### getConstraint__protocolTransitionOfPreCondition Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Retrieves the meta object for the reference '_protocol Transition Of Pre Condition_'. This method is part of the UMLPackage interface. ```APIDOC ## getConstraint__protocolTransitionOfPreCondition() ### Description Returns the meta object for the reference '_protocol Transition Of Pre Condition_'. ### Method N/A (Method Signature) ### Endpoint N/A (Interface Method) ### Parameters None ### Response - meta object for '_protocol Transition Of Pre Condition_' ``` -------------------------------- ### getActivationConditionProperty() Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the activation condition property. ```APIDOC ## getActivationConditionProperty() ### Description Gets the activation condition property. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **Property** - The activation condition property. ``` -------------------------------- ### getDeployment_Configuration Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the containment reference list '_Configuration_'. This method is part of the UMLPackage interface. ```APIDOC ## getDeployment_Configuration() ### Description Returns the meta object for the containment reference list '_Configuration_'. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### get_loopNodeOfSetupPart Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Retrieves the value of the 'loop Node Of Setup Part' container reference for an ExecutableNode. ```APIDOC ## get_loopNodeOfSetupPart ### Description Returns the value of the '_**loop Node Of Setup Part**_ ' container reference. ### Method GET ### Endpoint /uml/ExecutableNode/{id}/loopNodeOfSetupPart ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the ExecutableNode. ### Response #### Success Response (200) - **loopNodeOfSetupPart** (ExecutableNode) - The setup part reference. ``` -------------------------------- ### getUISymbolWithTextMetaclasses Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets metaclasses that use symbols with text. ```APIDOC ## getUISymbolWithTextMetaclasses() ### Description Gets metaclasses that use symbols with text, likely for UI prototyping. ### Method Static method ``` -------------------------------- ### UMLPackage Metadata Methods Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Methods for retrieving meta objects and references related to connection points and connectors from the UMLPackage metadata. ```APIDOC ## UMLPackage Metadata Methods ### getConnectionPointReference() Returns the meta object for class '`_Connection Point Reference_`'. ### getConnectionPointReference_Entry() Returns the meta object for the reference list '`_Entry_`'. ### getConnectionPointReference_Exit() Returns the meta object for the reference list '`_Exit_`'. ### getConnectionPointReference_State() Returns the meta object for the container reference '`_State_`'. ### getConnector() Returns the meta object for class '`_Connector_`'. ### getConnector__connectorOfRedefinedConnector() Returns the meta object for the reference list '`_connector Of Redefined Connector_`'. ### getConnector__informationFlowOfRealizingConnector() Returns the meta object for the reference list '`_information Flow Of Realizing Connector_`'. ### getConnector__messageOfConnector() Returns the meta object for the reference list '`_message Of Connector_`'. ### getConnector__structuredClassifierOfOwnedConnector() Returns the meta object for the container reference '`_structured Classifier Of Owned Connector_`'. ### getConnector_Contract() Returns the meta object for the reference list '`_Contract_`'. ### getConnector_End() Returns the meta object for the containment reference list '`_End_`'. ``` -------------------------------- ### getConstraint__transitionOfGuard Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Retrieves the meta object for the reference '_transition Of Guard_'. This method is part of the UMLPackage interface. ```APIDOC ## getConstraint__transitionOfGuard() ### Description Returns the meta object for the reference '_transition Of Guard_'. ### Method N/A (Method Signature) ### Endpoint N/A (Interface Method) ### Parameters None ### Response - meta object for '_transition Of Guard_' ``` -------------------------------- ### getTypeMapProperty Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the property related to the type map. ```APIDOC ## getTypeMapProperty() ### Description Retrieves the property associated with the type map. ### Method Not specified (likely a method call in a Java API) ``` -------------------------------- ### getOutputPin__reduceActionOfResult Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the container reference '_reduce Action Of Result'. This method is part of the UMLPackage interface. ```APIDOC ## getOutputPin__reduceActionOfResult ### Description Returns the meta object for the container reference '_reduce Action Of Result'. ### Method Method in interface com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage ``` -------------------------------- ### getTypeLanguageProperty Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets the property related to the type language. ```APIDOC ## getTypeLanguageProperty() ### Description Retrieves the property associated with the type language. ### Method Not specified (likely a method call in a Java API) ``` -------------------------------- ### getReplyAction_ReturnInformation Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the containment reference 'Return Information'. This method is part of the UMLPackage interface. ```APIDOC ## getReplyAction_ReturnInformation ### Description Returns the meta object for the containment reference 'Return Information'. ### Method N/A (Method signature provided) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### getStereotypePropertyValueAsString Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets tagged values as a list of strings. ```APIDOC ## getStereotypePropertyValueAsString(Element, Stereotype, String) ### Description Gets tagged values as a list of strings. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **Stereotype** (Stereotype) - The stereotype. - **String** (String) - The name of the tagged value property. ### Class com.nomagic.uml2.ext.jmi.helpers.TagsHelper ``` ```APIDOC ## getStereotypePropertyValueAsString(Element, Stereotype, String, boolean) ### Description Gets tagged values as a list of strings. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **Stereotype** (Stereotype) - The stereotype. - **String** (String) - The name of the tagged value property. - **boolean** (boolean) - A flag indicating whether to search recursively (behavior not fully specified in source). ### Class com.nomagic.uml2.ext.jmi.helpers.TagsHelper ``` ```APIDOC ## getStereotypePropertyValueAsString(Element, String, String) ### Description Gets tagged values as a list of strings. This is a deprecated method. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **String** (String) - The name of the stereotype. - **String** (String) - The name of the tagged value property. ### Class com.nomagic.uml2.ext.jmi.helpers.DeprecatedTagsHelper ### Deprecated Use `TagsHelper.getStereotypePropertyValueAsString(Element, Stereotype, String)` instead. ``` ```APIDOC ## getStereotypePropertyValueAsString(Element, String, String, boolean) ### Description Gets tagged values as a list of strings. This is a deprecated method. ### Method Static method ### Parameters - **Element** (Element) - The element containing the tagged values. - **String** (String) - The name of the stereotype. - **String** (String) - The name of the tagged value property. - **boolean** (boolean) - A flag indicating whether to search recursively (behavior not fully specified in source). ### Class com.nomagic.uml2.ext.jmi.helpers.DeprecatedTagsHelper ### Deprecated Use `TagsHelper.getStereotypePropertyValueAsString(Element, Stereotype, String, boolean)` instead. ``` -------------------------------- ### getReplyAction Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Returns the meta object for the class 'Reply Action'. This method is part of the UMLPackage interface. ```APIDOC ## getReplyAction ### Description Returns the meta object for the class 'Reply Action'. ### Method N/A (Method signature provided) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### getStereotypePropertyString Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Gets a stereotype property as a String value. ```APIDOC ## getStereotypePropertyString(Element, Stereotype, String) ### Description Gets a stereotype property as a String value. ### Method Static method ### Parameters - **Element** (Element) - The element containing the stereotype. - **Stereotype** (Stereotype) - The stereotype. - **String** (String) - The name of the property. ### Class com.nomagic.magicdraw.magicreport.helper.ReportHelper ``` ```APIDOC ## getStereotypePropertyString(Element, Stereotype, String, String) ### Description Gets a stereotype property as a String value. ### Method Static method ### Parameters - **Element** (Element) - The element containing the stereotype. - **Stereotype** (Stereotype) - The stereotype. - **String** (String) - The name of the property. - **String** (String) - An additional string parameter (purpose not fully specified in source). ### Class com.nomagic.magicdraw.magicreport.helper.ReportHelper ``` ```APIDOC ## getStereotypePropertyString(Element, String, String) ### Description Gets a stereotype property as a String value. ### Method Static method ### Parameters - **Element** (Element) - The element containing the stereotype. - **String** (String) - The name of the stereotype. - **String** (String) - The name of the property. ### Class com.nomagic.magicdraw.magicreport.helper.ReportHelper ``` ```APIDOC ## getStereotypePropertyString(Element, String, String, String) ### Description Gets a stereotype property as a String value. ### Method Static method ### Parameters - **Element** (Element) - The element containing the stereotype. - **String** (String) - The name of the stereotype. - **String** (String) - The name of the property. - **String** (String) - An additional string parameter (purpose not fully specified in source). ### Class com.nomagic.magicdraw.magicreport.helper.ReportHelper ``` ```APIDOC ## getStereotypePropertyString(Element, String, String, String, String) ### Description Gets a stereotype property as a String value. ### Method Static method ### Parameters - **Element** (Element) - The element containing the stereotype. - **String** (String) - The name of the stereotype. - **String** (String) - The name of the property. - **String** (String) - An additional string parameter (purpose not fully specified in source). - **String** (String) - Another additional string parameter (purpose not fully specified in source). ### Class com.nomagic.magicdraw.magicreport.helper.ReportHelper ``` -------------------------------- ### getPlugins Source: https://jdocs.nomagic.com/2024xRefresh3/index-files/index-7.html Retrieves all loaded plugins. ```APIDOC ## getPlugins() ### Description Retrieves a collection of all plugins that are currently loaded. ### Method This is a static method call within Java. ### Endpoint N/A (Java method) ### Parameters None. ### Response A list or collection of all loaded plugins. ```