### Set Up Test Case (Java)

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/tests/MagicDrawTestCase

Prepares the test case after the MagicDraw application has started. This method should be overridden for test-specific setup routines, replacing the default JUnit setUp(). It may throw a java.lang.Exception if issues occur during setup.

```java
@OpenApi
protected void setUpTest()
                           throws java.lang.Exception

```

--------------------------------

### Plugin Directory Management

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/plugins/PluginDescriptor

Methods for setting and getting the installation directory of the plugin.

```APIDOC
## setPluginDirectory

### Description
Sets the plugin installation directory. This is the directory where the plugin descriptor XML file was found.

### Method
`public void setPluginDirectory(java.io.File directory)`

### Parameters
#### Path Parameters
- **directory** (File) - Required - The plugin directory.

### Request Body
(Not applicable for this method)

### Response
(Not applicable for this method)

## getPluginDirectory

### Description
Returns the plugin installation directory. This is the directory where the plugin descriptor XML file was found.

### Method
`public java.io.File getPluginDirectory()`

### Parameters
(Not applicable for this method)

### Request Body
(Not applicable for this method)

### Response
#### Success Response (200)
- **directory** (File) - The plugin directory.

### Response Example
```json
{
  "directory": "/path/to/plugin"
}
```
```

--------------------------------

### Get Project Options (Java)

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/core/options/ProjectOptions

Methods to retrieve specific project settings. These are useful for querying the current state of project configurations, such as whether dot notation is enabled for associations. The `showDotNotationForAssociations()` method is an example of a getter.

```java
boolean showDotNotationForAssociations()
java.lang.String OPTIONS_LOCK
```

--------------------------------

### Execution Specification Start Setting

Source: https://jdocs.nomagic.com/190/index-files/index-19

Method for setting the start reference for an Execution Specification.

```APIDOC
## setStart / ExecutionSpecification

### Description
Sets the value of the '_Start_' reference for an Execution Specification.

### Method
N/A (Method signature)

### 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
```

--------------------------------

### MagicDrawTestCase Test Setup and Teardown

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/tests/MagicDrawTestCase

Methods for setting up and tearing down test cases. `setUpTest` is called after the MagicDraw application starts, and `tearDownTest` is called after test execution.

```java
protected void setUpTest()
```

```java
protected void tearDownTest()
```

--------------------------------

### Get Installed Project Features

Source: https://jdocs.nomagic.com/190/com/nomagic/ci/persistence/IProject

Retrieves a set of names for all features currently installed in the project. Returns an empty set if no features are installed.

```Java
java.util.Set<java.lang.String> getInstalledFeatures()
```

--------------------------------

### POST /application/start

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/core/Application

Starts the MagicDraw application.

```APIDOC
## POST /application/start

### Description
Starts the MagicDraw application. This method can be called with various parameters to control the startup behavior.

### Method
POST

### Endpoint
`/application/start`

### Parameters
#### Query Parameters
- **visible** (boolean) - Optional - Specifies if the application GUI should be visible.
- **silentMode** (boolean) - Optional - Runs the application in silent mode without user interaction.
- **tryToLoadProject** (boolean) - Optional - Attempts to load a project on startup.

#### Request Body
- **args** (array of strings) - Optional - Command-line arguments to pass to the application.
- **participant** (StartupParticipant) - Optional - A participant to be executed during startup.

### Request Example
```json
{
  "args": ["--open", "path/to/project.mdzip"],
  "visible": true,
  "silentMode": false,
  "tryToLoadProject": true,
  "participant": null
}
```

### Response
#### Success Response (200)
Indicates that the application startup process has been initiated.

#### Response Example
```json
{
  "status": "started"
}
```

#### Error Response (e.g., 500)
- **error** (string) - Description of the error that occurred during startup.
```json
{
  "error": "Failed to initialize graphics subsystem."
}
```
```

--------------------------------

### Get Project Feature by Type

Source: https://jdocs.nomagic.com/190/com/nomagic/ci/persistence/IProject

Retrieves an installed project feature based on its class type. Returns null if the feature is not installed.

```Java
T getFeature(java.lang.Class<T> featureType)
```

--------------------------------

### init(String, long)

Source: https://jdocs.nomagic.com/190/index-files/index-9

Initializes progress.

```APIDOC
## init(String, long)

### Description
Initializes progress.

### Method
(Not specified, likely constructor or initialization method)

### Endpoint
(Not applicable for Java methods)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(Not applicable for Java methods)

### Response
#### Success Response (N/A)
(None)

#### Response Example
(Not applicable for Java methods)
```

--------------------------------

### Get Scenario Node Start

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/usecasescenarios/scenarios/ScenarioNode

Retrieves the starting point of the scenario node. This is relevant for understanding the flow and transitions within a scenario.

```java
ScenarioNodeStart getStart()

```

--------------------------------

### init(String, long, long, long)

Source: https://jdocs.nomagic.com/190/index-files/index-9

Initializes progress.

```APIDOC
## init(String, long, long, long)

### Description
Initializes progress.

### Method
(Not specified, likely constructor or initialization method)

### Endpoint
(Not applicable for Java methods)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(Not applicable for Java methods)

### Response
#### Success Response (N/A)
(None)

#### Response Example
(Not applicable for Java methods)
```

--------------------------------

### init(String, long, long)

Source: https://jdocs.nomagic.com/190/index-files/index-9

Initializes progress.

```APIDOC
## init(String, long, long)

### Description
Initializes progress.

### Method
(Not specified, likely constructor or initialization method)

### Endpoint
(Not applicable for Java methods)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(Not applicable for Java methods)

### Response
#### Success Response (N/A)
(None)

#### Response Example
(Not applicable for Java methods)
```

--------------------------------

### Get Loop Node of Setup Part - Java

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/ext/magicdraw/activities/mdstructuredactivities/ExecutableNode

Retrieves the LoopNode associated with the setup part of a loop. This is a bidirectional reference where the opposite is 'Setup Part'. Further description is needed for clarity. The method is annotated with @CheckForNull.

```java
@CheckForNull
LoopNode get_loopNodeOfSetupPart()
```

--------------------------------

### Initialization Methods

Source: https://jdocs.nomagic.com/190/index-files/index-9

This section documents various initialization methods found across different interfaces and classes, focusing on setup procedures.

```APIDOC
## Initialization Methods

### Description
This section details various initialization methods used across different components of the Nomagic platform for setup and configuration.

### Method
N/A (Methods)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

#### Key Initialization Methods:
- `init(PersistenceManager, IProgressMonitor)`:
  - Interface: `com.nomagic.magicdraw.dependencymatrix.datamodel.cell.DependencyExtractor`
  - Description: Called when matrix settings change and the matrix is rebuilt.
- `init(PersistenceManager, IProgressMonitor)`:
  - Interface: `com.nomagic.magicdraw.dependencymatrix.datamodel.editing.DependencyEditor`
  - Description: Initializes the value editor.
- `init()`:
  - Class: `com.nomagic.magicdraw.plugins.Plugin`
  - Description: Plugin initialization method.
- `init(Browser, Project)`:
  - Interface: `com.nomagic.magicdraw.ui.browser.Browser.BrowserInitializer`
  - Description: Initializes the browser.
- `init(Collection, Collection, Collection, boolean, boolean)`:
  - Class: `com.nomagic.magicdraw.ui.dialogs.SelectElementTypes`
  - Description: Initializes the element type selection dialog.
- `init(Project, Constraint)`:
  - Class: `com.nomagic.magicdraw.validation.DefaultValidationRuleImpl`
  - Description: Initializes the validation rule instance.
- `init(Project, Constraint)`:
  - Class: `com.nomagic.magicdraw.validation.DiagramValidator`
  - Description: Initializes the diagram validator.
- `init(Project, Constraint)`:
  - Interface: `com.nomagic.magicdraw.validation.ElementValidationRuleImpl`
  - Description: The first method invoked on an element validation rule implementation.
- `init(Project, Constraint)`:
  - Class: `com.nomagic.magicdraw.validation.OpenedDiagramValidator`
  - Description: Initializes the validator for opened diagrams.

```

--------------------------------

### init(boolean)

Source: https://jdocs.nomagic.com/190/index-files/index-9

Placeholder for method documentation.

```APIDOC
## init(boolean)

### Description
Placeholder for method documentation.

### Method
(Not specified, likely constructor or initialization method)

### Endpoint
(Not applicable for Java methods)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(Not applicable for Java methods)

### Response
#### Success Response (N/A)
(None)

#### Response Example
(Not applicable for Java methods)
```

--------------------------------

### Start Object Behavior Action API

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/ext/magicdraw/actions/mdbasicactions/InputPin

Provides methods to get and set the 'start Object Behavior Action Of Object' container reference.

```APIDOC
## GET /websites/jdocs_nomagic_190/startObjectBehaviorAction

### Description
Retrieves the value of the '_start Object Behavior Action Of Object_' container reference. This reference is bidirectional and its opposite is '_Object_'.

### Method
GET

### Endpoint
/websites/jdocs_nomagic_190/startObjectBehaviorAction

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **startObjectBehaviorAction** (StartObjectBehaviorAction) - The value of the '_start Object Behavior Action Of Object_' container reference.

#### Response Example
```json
{
  "startObjectBehaviorAction": "<value>"
}
```

## POST /websites/jdocs_nomagic_190/startObjectBehaviorAction

### Description
Sets the value of the '_start Object Behavior Action Of Object_' container reference.

### Method
POST

### Endpoint
/websites/jdocs_nomagic_190/startObjectBehaviorAction

### Parameters
#### Request Body
- **value** (StartObjectBehaviorAction) - Required - The new value for the '_start Object Behavior Action Of Object_' container reference.

### Request Example
```json
{
  "value": "<new_value>"
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates the operation was successful.

#### Response Example
```json
{
  "message": "Successfully updated startObjectBehaviorAction"
}
```
```

--------------------------------

### main

Source: https://jdocs.nomagic.com/190/com/nomagic/utils/Utilities

The entry point for the application.

```APIDOC
## main

### Description
The entry point for the application.

### Method
`static void main(String[] args)`

### Parameters
#### Parameters
- **args** (String[]) - Required - Command line arguments.
```

--------------------------------

### Start Classifier Behavior Action API

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/ext/magicdraw/actions/mdbasicactions/InputPin

Provides methods to get and set the 'start Classifier Behavior Action Of Object' container reference.

```APIDOC
## GET /websites/jdocs_nomagic_190/startClassifierBehaviorAction

### Description
Retrieves the value of the '_start Classifier Behavior Action Of Object_' container reference. This reference is bidirectional and its opposite is '_Object_'.

### Method
GET

### Endpoint
/websites/jdocs_nomagic_190/startClassifierBehaviorAction

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **startClassifierBehaviorAction** (StartClassifierBehaviorAction) - The value of the '_start Classifier Behavior Action Of Object_' container reference.

#### Response Example
```json
{
  "startClassifierBehaviorAction": "<value>"
}
```

## POST /websites/jdocs_nomagic_190/startClassifierBehaviorAction

### Description
Sets the value of the '_start Classifier Behavior Action Of Object_' container reference.

### Method
POST

### Endpoint
/websites/jdocs_nomagic_190/startClassifierBehaviorAction

### Parameters
#### Request Body
- **value** (StartClassifierBehaviorAction) - Required - The new value for the '_start Classifier Behavior Action Of Object_' container reference.

### Request Example
```json
{
  "value": "<new_value>"
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates the operation was successful.

#### Response Example
```json
{
  "message": "Successfully updated startClassifierBehaviorAction"
}
```
```

--------------------------------

### ModelVisitorAdapter Constructor and Methods

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/impl/ModelVisitorAdapter

This section details the constructor and all the visitor methods available in the ModelVisitorAdapter class. Each method corresponds to a specific UML element type.

```APIDOC
## ModelVisitorAdapter API Documentation

### Description
This API documentation covers the `ModelVisitorAdapter` class, which serves as a base implementation for the `ModelVisitor` interface. It provides default implementations for visiting various UML elements, allowing developers to override specific `visit` methods to implement custom visitor logic.

### Constructor Summary

*   `ModelVisitorAdapter()`: Default constructor for the `ModelVisitorAdapter` class.

### Method Summary

All Methods | Instance Methods | Concrete Methods

*   `void visitAbstraction(Abstraction element, VisitorContext context)`: Visitor method for `Abstraction` elements.
*   `void visitAcceptCallAction(AcceptCallAction element, VisitorContext context)`: Visitor method for `AcceptCallAction` elements.
*   `void visitAcceptEventAction(AcceptEventAction element, VisitorContext context)`: Visitor method for `AcceptEventAction` elements.
*   `void visitAction(Action element, VisitorContext context)`: Visitor method for `Action` elements.
*   `void visitActionExecutionSpecification(ActionExecutionSpecification element, VisitorContext context)`: Visitor method for `ActionExecutionSpecification` elements.
*   `void visitActionInputPin(ActionInputPin element, VisitorContext context)`: Visitor method for `ActionInputPin` elements.
*   `void visitActivity(Activity element, VisitorContext context)`: Visitor method for `Activity` elements.
*   `void visitActivityEdge(ActivityEdge element, VisitorContext context)`: Visitor method for `ActivityEdge` elements.
*   `void visitActivityFinalNode(ActivityFinalNode element, VisitorContext context)`: Visitor method for `ActivityFinalNode` elements.
*   `void visitActivityGroup(ActivityGroup element, VisitorContext context)`: Visitor method for `ActivityGroup` elements.
*   `void visitActivityNode(ActivityNode element, VisitorContext context)`: Visitor method for `ActivityNode` elements.
*   `void visitActivityParameterNode(ActivityParameterNode element, VisitorContext context)`: Visitor method for `ActivityParameterNode` elements.
*   `void visitActivityPartition(ActivityPartition element, VisitorContext context)`: Visitor method for `ActivityPartition` elements.
*   `void visitActor(Actor element, VisitorContext context)`: Visitor method for `Actor` elements.
*   `void visitAddStructuralFeatureValueAction(AddStructuralFeatureValueAction element, VisitorContext context)`: Visitor method for `AddStructuralFeatureValueAction` elements.
*   `void visitAddVariableValueAction(AddVariableValueAction element, VisitorContext context)`: Visitor method for `AddVariableValueAction` elements.
*   `void visitAnyReceiveEvent(AnyReceiveEvent element, VisitorContext context)`: Visitor method for `AnyReceiveEvent` elements.
*   `void visitArtifact(Artifact element, VisitorContext context)`: Visitor method for `Artifact` elements.
*   `void visitAssociation(Association element, VisitorContext context)`: Visitor method for `Association` elements.
*   `void visitAssociationClass(AssociationClass element, VisitorContext context)`: Visitor method for `AssociationClass` elements.
*   `void visitBehavior(Behavior element, VisitorContext context)`: Visitor method for `Behavior` elements.
*   `void visitBehavioralFeature(BehavioralFeature element, VisitorContext context)`: Visitor method for `BehavioralFeature` elements.
*   `void visitBehavioredClassifier(BehavioredClassifier element, VisitorContext context)`: Visitor method for `BehavioredClassifier` elements.
*   `void visitBehaviorExecutionSpecification(BehaviorExecutionSpecification element, VisitorContext context)`: Visitor method for `BehaviorExecutionSpecification` elements.
*   `void visitBroadcastSignalAction(BroadcastSignalAction element, VisitorContext context)`: Visitor method for `BroadcastSignalAction` elements.
*   `void visitCallAction(CallAction element, VisitorContext context)`: Visitor method for `CallAction` elements.
*   `void visitCallBehaviorAction(CallBehaviorAction element, VisitorContext context)`: Visitor method for `CallBehaviorAction` elements.
*   `void visitCallEvent(CallEvent element, VisitorContext context)`: Visitor method for `CallEvent` elements.
*   `void visitCallOperationAction(CallOperationAction element, VisitorContext context)`: Visitor method for `CallOperationAction` elements.

### Request Example

This API does not involve direct HTTP requests. The methods are called within a Java application context during the traversal of a UML model.

### Response

This API does not involve direct HTTP responses. The "response" to a visitor method is the execution of the custom logic within the overridden method or the default behavior of the adapter.

#### Success Response (N/A)

#### Response Example (N/A)

### Error Handling

Errors are typically handled through standard Java exception mechanisms. No specific API error codes are defined for these visitor methods.
```

--------------------------------

### Get Scenario Start Node

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/usecasescenarios/scenarios/Scenario

Retrieves the starting node of the scenario. This node represents the initial point or action within the scenario flow.

```java
ScenarioNodeStart getScenarioStart()

```

--------------------------------

### SmartListenerConfig Initialization Methods

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/ext/jmi/smartlistener/SmartListenerConfig

Methods for initializing various configuration aspects of SmartListenerConfig.

```APIDOC
## initStereotypeAndTagsInstanceSpecificationConfig

### Description
Initializes stereotypes and tags instance specification config.

### Method
static void

### Endpoint
N/A (Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## initValueSpecificationConfig (overload 1)

### Description
Initializes value specification config.

### Method
static void

### Endpoint
N/A (Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## initValueSpecificationConfig (overload 2)

### Description
Initializes value specification config.

### Method
static void

### Endpoint
N/A (Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Get Feature ID for Loop Node of Setup Part (Java)

Source: https://jdocs.nomagic.com/190/index-files/index-18

Retrieves the feature ID for the 'loop Node Of Setup Part' reference. This constant in the UMLPackage interface identifies the setup part of a loop node in UML activity diagrams.

```java
com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage.RECLASSIFY_OBJECT_ACTION___LOOP_NODE_OF_SETUP_PART
```

--------------------------------

### Application Environment Methods

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/core/Application.Environment

This section details the methods available for interacting with the application's environment, allowing access to configuration, data, and installation directories.

```APIDOC
## GET /environment/configDir

### Description
Retrieves the directory where configuration files for each user are stored. This method may create the configuration directories if they do not exist.

### Method
GET

### Endpoint
/environment/configDir

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **directory** (string) - The path to the configuration directory.

#### Response Example
{
  "directory": "/path/to/user/config"
}

## GET /environment/dataDirectory

### Description
Retrieves the data directory, which is a combination of the application's installation root and the data folder.

### Method
GET

### Endpoint
/environment/dataDirectory

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **directory** (string) - The path to the data directory.

#### Response Example
{
  "directory": "/opt/magicdraw/data"
}

## GET /environment/defaultsDataDirectory

### Description
Retrieves the directory within the installation root where default settings, such as custom diagrams and user modes, are saved.

### Method
GET

### Endpoint
/environment/defaultsDataDirectory

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **directory** (file) - The default data directory.

#### Response Example
{
  "directory": "/opt/magicdraw/defaults"
}

## GET /environment/examplesDirectory

### Description
Retrieves the directory containing examples for the application.

### Method
GET

### Endpoint
/environment/examplesDirectory

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **directory** (string) - The path to the examples directory.

#### Response Example
{
  "directory": "/opt/magicdraw/examples"
}

## GET /environment/installRoot

### Description
Retrieves the root directory of the application installation.

### Method
GET

### Endpoint
/environment/installRoot

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **directory** (string) - The application installation root path.

#### Response Example
{
  "directory": "/opt/magicdraw"
}

## GET /environment/profilesDirectory

### Description
Retrieves the directory where application profiles are stored.

### Method
GET

### Endpoint
/environment/profilesDirectory

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **directory** (string) - The path to the profiles directory.

#### Response Example
{
  "directory": "/opt/magicdraw/profiles"
}

## GET /environment/resourceDirectory

### Description
Retrieves the directory containing application resources.

### Method
GET

### Endpoint
/environment/resourceDirectory

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **directory** (string) - The path to the resources directory.

#### Response Example
{
  "directory": "/opt/magicdraw/resources"
}

## GET /environment/templatesDirectory

### Description
Retrieves the templates directory, which is a combination of the application's installation root and the templates folder.

### Method
GET

### Endpoint
/environment/templatesDirectory

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **directory** (string) - The path to the templates directory.

#### Response Example
{
  "directory": "/opt/magicdraw/templates"
}

## GET /environment/userDataDirectory

### Description
Retrieves the directory in the user's home folder where configuration files are saved (e.g., custom diagrams, user modes).

### Method
GET

### Endpoint
/environment/userDataDirectory

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **directory** (file) - The user data directory.

#### Response Example
{
  "directory": "/home/user/.magicdraw/config"
}

## GET /environment/userHomeDirectory

### Description
Retrieves the user's home directory.

### Method
GET

### Endpoint
/environment/userHomeDirectory

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **directory** (string) - The path to the user's home directory.

#### Response Example
{
  "directory": "/home/user"
}

## GET /environment/tempDir

### Description
Gets a temporary directory that is unique for this application instance. You can optionally provide a path within the temp folder.

### Method
GET

### Endpoint
/environment/tempDir

### Parameters
#### Query Parameters
- **path** (string) - Optional. A path within the temp folder. If empty, returns the temp folder root.

### Request Example
None

### Response
#### Success Response (200)
- **directory** (file) - The application unique temporary folder.

#### Response Example
{
  "directory": "/tmp/magicdraw_instance_12345"
}

```

--------------------------------

### Get Start Occurrence Specification (Java)

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/ext/magicdraw/interactions/mdbasicinteractions/ExecutionSpecification

Retrieves the start OccurrenceSpecification for an Action or Behavior. This method returns the value of the '_Start_' reference, which is bidirectional and links to OccurrenceSpecification.

```java
@CheckForNull
OccurrenceSpecification getStart()

```

--------------------------------

### Get View Start Offset (Java)

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/uml/symbols/shapes/html/HTMLHelper.Renderer

Returns the starting offset within the document model that this view corresponds to. This is crucial for understanding the portion of the document managed by the view.

```java
public int getStartOffset()
```

--------------------------------

### MagicDraw Application Startup

Source: https://jdocs.nomagic.com/190/index-files/index-13

Details on the main application startup class and its methods.

```APIDOC
## MagicDraw Application Startup

### Description
Class responsible for the initial startup of the MagicDraw application.

### Class
com.nomagic.magicdraw.Main

### Constructors
- **Main()**: Constructor for class com.nomagic.magicdraw.Main

### Static Methods
- **main(String[])**: Application main startup method.
```

--------------------------------

### Get Setup Part Executable Nodes

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/ext/magicdraw/activities/mdstructuredactivities/LoopNode

Returns a collection of ExecutableNodes executed before the first loop iteration for initialization or setup computations. The collection is bidirectional and its opposite is 'loopNodeOfSetupPart'.

```java
java.util.Collection<ExecutableNode> getSetupPart()

```

--------------------------------

### Browser.BrowserInitializer.WindowComponentInfoRegistration Variable

Source: https://jdocs.nomagic.com/190/index-files/index-14

Documentation for the nextTo variable in the WindowComponentInfoRegistration class.

```APIDOC
## Browser.BrowserInitializer.WindowComponentInfoRegistration.nextTo

### Description
A variable likely used for positioning or relating UI components within the browser.

### Variable
* **nextTo** (Variable)
```

--------------------------------

### Project Feature Management

Source: https://jdocs.nomagic.com/190/com/nomagic/ci/persistence/IProject

Facilitates the management of project features. This includes methods to get installed features, install new features, uninstall existing features, and retrieve specific features by type or data manager.

```java
<T extends com.nomagic.ci.persistence.features.IProjectFeature> T getFeature(java.lang.Class<T> featureType)
com.nomagic.ci.persistence.features.FeatureDataManager getFeatureDataManager(com.nomagic.ci.persistence.features.IProjectFeatureDescriptor feature, com.nomagic.ci.persistence.features.FeatureDataSetFilter... featureResourceFilters)
java.util.Set<java.lang.String> getInstalledFeatures()
void installFeatures(java.util.Set<java.lang.String> featureNames, org.eclipse.core.runtime.IProgressMonitor monitor)
void uninstallFeatures(java.util.Set<java.lang.String> featureNames, org.eclipse.core.runtime.IProgressMonitor monitor)

```

--------------------------------

### Login with Options and Progress Status (Java)

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/teamwork2/TeamworkService

Attempts to log in using provided options and a progress status indicator. This protected abstract method is expected to return true upon successful login. It is an implementation detail within the service.

```java
protected abstract boolean loginFromOptions(@CheckForNull
                                            java.util.Map<java.lang.String,java.lang.Boolean> options,
                                            ProgressStatus status)
```

--------------------------------

### Get Plugin Directory

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/plugins/PluginDescriptor

Retrieves the installation directory of the plugin. This method returns a File object representing the plugin's directory.

```java
public java.io.File getPluginDirectory()
```

--------------------------------

### ProjectOptions Constructor and Methods

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/core/options/ProjectOptions

Details the constructor and various methods for managing project options, including setting defaults, styles, and module directories.

```APIDOC
## ProjectOptions Class

### Constructor

- **ProjectOptions()**
  - Description: Creates project options with initialized defaults. Use this constructor when compatibility properties converting should be performed.

### Methods

- **remapGroupInUI(Collection<String> groupsToRemap, Group newGroup)**
  - Description: Remaps properties group to some other group in options UI.
  - Parameters:
    - `groupsToRemap` (Collection<String>) - Required - Groups to remap.
    - `newGroup` (Group) - Required - The new group.

- **getGroupRemap()**
  - Returns: Map<Collection<String>, Group>
  - Description: Retrieves the group remapping.

- **createDefaultProjectOptions(Project project)**
  - Returns: ProjectOptions
  - Description: Creates default options for a given project.
  - Parameters:
    - `project` (Project) - Required - The project for which to create default options.

- **setProject(Project project)**
  - Description: Sets the project for the options.
  - Parameters:
    - `project` (Project) - Required - The project to set.

- **setDefaults()**
  - Description: Sets default project options.

- **getStyle()**
  - Returns: Style
  - Description: Gets the style that holds two properties managers: one for visible and user-editable properties, and another for invisible project properties.

- **setStyle(Style style)**
  - Description: Sets the style that holds two properties managers: one for visible and user-editable properties, and another for invisible project properties.
  - Parameters:
    - `style` (Style) - Required - The project properties style.

- **getPersonalOptionsStyle()**
  - Returns: Style
  - Description: Gets the personalOptionsStyle from the ProjectOptions. Personal options are GUI settings that are user-specific in a multi-user environment.

- **getDiagramViewStyle()**
  - Returns: Style
  - Description: Gets the diagramViewStyle from the ProjectOptions. Personal options are GUI settings that are user-specific in a multi-user environment.

- **getSymbolStyles()**
  - Returns: StyleManager
  - Description: Gets the symbol style manager.

- **addModuleDirectory(String directory)**
  - Description: Adds a directory to the project's module directories.
  - Parameters:
    - `directory` (String) - Required - The directory to add.

- **checkAndAddModuleDirectory(String directory)**
  - Description: Adds a directory to the project's module directories if it has not been added yet.
  - Parameters:
    - `directory` (String) - Required - The directory to add.

- **setModulesDirectories()**
  - Description: Sets the project module directories.
```

--------------------------------

### EmfOptionsGroup - Get EMF Options

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/emfuml2xmi/v2/envoptions/EmfOptionsGroup

Retrieves the Eclipse UML2 XMI v2.x export/import options. This method should only be called after the application has started.

```APIDOC
## GET /emf-options

### Description
Retrieves the Eclipse UML2 XMI v2.x export/import options. Access these options only after the application has started.

### Method
GET

### Endpoint
/emf-options

### Parameters
None

### Request Example
```json
{
  "example": "No request body needed for GET request"
}
```

### Response
#### Success Response (200)
- **EmfOptionsGroup** (object) - The loaded environment options for Eclipse UML2 XMI v2.x export/import.

#### Response Example
```json
{
  "example": "EmfOptionsGroup object details"
}
```
```

--------------------------------

### beforeMainWindow Method Implementation (Java)

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/core/StartupParticipant

This method is called before the main application window is created during MagicDraw startup. The application environment is already set up at this point. This method has a void return type and no parameters.

```java
void beforeMainWindow()

Is called before creating main application window. Application environment already set up.
```

--------------------------------

### Help API

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/help/Help

Provides utility methods for showing help content. This class follows a singleton pattern.

```APIDOC
## Help Class

### Description
Utility class for showing a help.

### Methods

#### `getInstance()`

##### Description
Singleton method to return an instance of the Help class.

##### Method
`static Help getInstance()`

##### Returns
- `Help` - The singleton instance of the Help class.

#### `showTopic(String topicId)`

##### Description
Shows help content for a given topic ID.

##### Method
`void showTopic(String topicId)`

##### Parameters
- **topicId** (String) - Required - The identifier of the help topic to display.

##### Inheritance
Methods inherited from class `java.lang.Object`: `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
```

--------------------------------

### Get Execution Specification

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/ext/magicdraw/interactions/mdbasicinteractions/ExecutionOccurrenceSpecification

Retrieves the value of the 'Execution' reference, which represents the execution specification describing the execution that is started or finished at this execution event.

```APIDOC
## GET /websites/jdocs_nomagic_190/execution

### Description
Retrieves the value of the '_Execution_ ' reference. It is bidirectional and its opposite is '`.ExecutionSpecification#get_executionOccurrenceSpecificationOfExecution _execution Occurrence Specification Of Execution_`'. References the execution specification describing the execution that is started or finished at this execution event.

### Method
GET

### Endpoint
/websites/jdocs_nomagic_190/execution

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **executionSpecification** (ExecutionSpecification) - The execution specification.

#### Response Example
```json
{
  "executionSpecification": {
    "_executionOccurrenceSpecificationOfExecution": "..."
  }
}
```
```

--------------------------------

### GET /api/elements/find/{root}

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/uml/Finder.ByTypeRecursivelyFinder

Finds all elements of specified types starting from a given root element, with options to include the root and additional content.

```APIDOC
## GET /api/elements/find/{root}

### Description
Collect all elements of given specific type (not super class or interface) from the root element.

### Method
GET

### Endpoint
/api/elements/find/{root}

### Parameters
#### Path Parameters
- **root** (Element) - Required - The root element for the search.

#### Query Parameters
- **types** (Class[]) - Required - An array of Element's class types (e.g., Class.class, Package.class, Property.class).
- **includeRoot** (boolean) - Optional - Whether to include the root element in the search results. Defaults to true.
- **includeAdditionalContents** (boolean) - Optional - Whether to include additional content of Element defined in DSL. Defaults to false.
- **monitor** (IProgressMonitor) - Optional - A progress monitor to track the search operation.

### Request Example
```json
{
  "types": ["Property.class"],
  "includeRoot": false,
  "includeAdditionalContents": true
}
```

### Response
#### Success Response (200)
- **elements** (Collection<T>) - A collection of found elements of the specified types.

#### Response Example
```json
{
  "elements": [
    {
      "name": "exampleProperty",
      "type": "Property"
    }
  ]
}
```
```

--------------------------------

### Menu and File Handling Methods

Source: https://jdocs.nomagic.com/190/index-files/index-19

Methods for setting menu factories, file locations, and file properties.

```APIDOC
## POST /actions/menu/setFactory

### Description
Sets the menu component factory.

### Method
POST

### Endpoint
/actions/menu/setFactory

### Parameters
#### Request Body
- **factory** (MenuComponentFactory) - Required - The factory to set for menu components.

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

### Response Example
```json
{
  "status": "success"
}
```

## POST /file/location/register

### Description
Registers a file location.

### Method
POST

### Endpoint
/file/location/register

### Parameters
#### Request Body
- **locationNameID** (String) - Required - The ID of the location name.
- **file** (File) - Required - The file to register.

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

### Response Example
```json
{
  "status": "success"
}
```

## PUT /file/property/setFileExtensions

### Description
Sets the supported file extensions for a file property.

### Method
PUT

### Endpoint
/file/property/setFileExtensions

### Parameters
#### Request Body
- **extensions** (List<String>) - Required - A list of supported file extensions.

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Check Install Root Writable Status

Source: https://jdocs.nomagic.com/190/com/nomagic/utils/Utilities

Checks if the installation root directory is writable. It can optionally skip Windows User Account Control (UAC) prompts. Returns a message indicating the status or error, useful for setup or update processes.

```java
static java.lang.String checkIsInstallRootWritable(com.nomagic.runtime.RuntimeEnvironment runtime)
static java.lang.String checkIsInstallRootWritable(com.nomagic.runtime.RuntimeEnvironment runtime, boolean skipWinUAC)
```

--------------------------------

### SmartListenerConfig Constructors

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/ext/jmi/smartlistener/SmartListenerConfig

Details on how to construct SmartListenerConfig objects, with and without initial properties or configurations.

```APIDOC
## SmartListenerConfig Constructors

### Description
Provides various ways to instantiate and initialize a `SmartListenerConfig` object.

### Method
Various (Constructor)

### Endpoint
N/A (Class Constructors)

#### Parameters

*   **`SmartListenerConfig()`**: Constructs the configuration.
*   **`SmartListenerConfig(String propertyName)`**: Constructs the configuration with a property name.
    *   `propertyName` (String) - Required - property name to use as a reference.
*   **`SmartListenerConfig(String propertyName, SmartListenerConfig config)`**: Constructs the configuration.
    *   `propertyName` (String) - Required - property name to use as a reference.
    *   `config` (SmartListenerConfig) - Required - config to use with a property reference.
*   **`SmartListenerConfig(Map<String, SmartListenerConfig> references)`**: Constructs smart listener config.
    *   `references` (Map<String, SmartListenerConfig>) - Required - references to use.

### Request Example
```json
{
  "example": "N/A for constructors"
}
```

### Response
#### Success Response (200)
N/A (Constructors do not return responses in the typical API sense)

#### Response Example
```json
{
  "example": "N/A for constructors"
}
```
```

--------------------------------

### Create HTML Start Tag - Java

Source: https://jdocs.nomagic.com/190/com/nomagic/text/html/HtmlTextUtils

Generates an HTML start tag for a given tag name. For example, passing "p" will return "<p>". This is a fundamental utility for building HTML structures programmatically.

```java
public static java.lang.String startTag(java.lang.String tag)
```

--------------------------------

### Get Execution Specification

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/ext/magicdraw/interactions/mdbasicinteractions/ExecutionOccurrenceSpecification

Retrieves the value of the 'Execution' reference, which describes the execution specification started or finished at an event. It is a bidirectional reference with a corresponding method in ExecutionSpecification.

```java
@CheckForNull
ExecutionSpecification getExecution()

```

--------------------------------

### Configuration Options

Source: https://jdocs.nomagic.com/190/index-files/index-19

This section details various methods for configuring display and notification settings.

```APIDOC
## Configuration Options

### Description

This API provides methods to control various display and notification settings within the application. These methods typically take a boolean argument to enable or disable a specific feature.

### Methods

#### `setShowMappinWarning(boolean)`

- **Description**: Set if show warnings about (datatypes, metaclasses) mappings.
- **Method**: Not Applicable (Method Signature Provided)
- **Class**: `com.nomagic.magicdraw.emfuml2xmi.envoptions.BaseOptions`

#### `setShowMultipleNotifications(boolean)`

- **Description**: Sets if the same notification can be displayed many times simultaneously.
- **Method**: Not Applicable (Method Signature Provided)
- **Class**: `com.nomagic.magicdraw.ui.notification.config.NotificationViewConfig`

#### `setShowMultiplicity(boolean)`

- **Description**: Controls the display of multiplicity in various UML element texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Classes**: `com.nomagic.magicdraw.uml.text.PinTextParams`, `com.nomagic.magicdraw.uml.text.PropertyTextParams`, `com.nomagic.magicdraw.uml.text.TypedElementTextParams`

#### `setShowName(boolean)`

- **Description**: Controls the display of names in various UML element texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Classes**: `com.nomagic.magicdraw.uml.text.BehaviorTextParams`, `com.nomagic.magicdraw.uml.text.ConstraintTextParams`, `com.nomagic.magicdraw.uml.text.MemberTextParams`, `com.nomagic.magicdraw.uml.text.OperationTextParams`, `com.nomagic.magicdraw.uml.text.PinTextParams`, `com.nomagic.magicdraw.uml.text.PropertyTextParams`, `com.nomagic.magicdraw.uml.text.ReceptionTextParams`, `com.nomagic.magicdraw.uml.text.SlotTextParams`, `com.nomagic.magicdraw.uml.text.TypedElementTextParams`

#### `setShowNotLockedElementsNotification(boolean)`

- **Description**: Controls notifications for elements that are not locked.
- **Method**: Not Applicable (Method Signature Provided)
- **Class**: `com.nomagic.magicdraw.teamwork2.locks.ILockProjectService.LockOptions`

#### `setShowOpaqueBehaviorBody(boolean)`

- **Description**: Controls the display of the body for opaque behaviors.
- **Method**: Not Applicable (Method Signature Provided)
- **Classes**: `com.nomagic.magicdraw.uml.text.BehaviorTextParams`, `com.nomagic.magicdraw.uml.text.TransitionTextParams`

#### `setShowOperationsSignature(boolean)`

- **Description**: Controls the display of operation signatures in various UML element texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Classes**: `com.nomagic.magicdraw.uml.text.EventTextParams`, `com.nomagic.magicdraw.uml.text.TransitionTextParams`, `com.nomagic.magicdraw.uml.text.TriggerTextParams`

#### `setShowOrder(boolean)`

- **Description**: Controls the display of order in multiplicity texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Class**: `com.nomagic.magicdraw.uml.text.MultiplicityTextParams`

#### `setShowParameterDirectionKind(boolean)`

- **Description**: Controls the display of parameter direction kind in various UML element texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Classes**: `com.nomagic.magicdraw.uml.text.BehaviorTextParams`, `com.nomagic.magicdraw.uml.text.OperationTextParams`, `com.nomagic.magicdraw.uml.text.ReceptionTextParams`

#### `setShowParameters(boolean)`

- **Description**: Controls the display of parameters in various UML element texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Classes**: `com.nomagic.magicdraw.uml.text.BehaviorTextParams`, `com.nomagic.magicdraw.uml.text.MessageTextParams`, `com.nomagic.magicdraw.uml.text.OperationTextParams`, `com.nomagic.magicdraw.uml.text.ReceptionTextParams`

#### `setShowPort(boolean)`

- **Description**: Controls the display of ports in transition and trigger texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Classes**: `com.nomagic.magicdraw.uml.text.TransitionTextParams`, `com.nomagic.magicdraw.uml.text.TriggerTextParams`

#### `setShowProperties(boolean)`

- **Description**: Controls the display of properties in various UML element texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Classes**: `com.nomagic.magicdraw.uml.text.BehaviorTextParams`, `com.nomagic.magicdraw.uml.text.MemberTextParams`, `com.nomagic.magicdraw.uml.text.OperationTextParams`, `com.nomagic.magicdraw.uml.text.PropertyTextParams`, `com.nomagic.magicdraw.uml.text.ReceptionTextParams`

#### `setShowQualifiedName(boolean)`

- **Description**: Controls the display of qualified names in slot texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Class**: `com.nomagic.magicdraw.uml.text.SlotTextParams`

#### `setShowReturnDirection(boolean)`

- **Description**: Controls the display of return direction in parameter texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Class**: `com.nomagic.magicdraw.uml.text.ParameterDirectionTextParams`

#### `setShowSpecification(boolean)`

- **Description**: Controls the display of specifications in constraint texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Class**: `com.nomagic.magicdraw.uml.text.ConstraintTextParams`

#### `setShowStereotype(boolean)`

- **Description**: Controls the display of stereotypes in various UML element texts.
- **Method**: Not Applicable (Method Signature Provided)
- **Classes**: `com.nomagic.magicdraw.uml.text.BehaviorTextParams`, `com.nomagic.magicdraw.uml.text.MemberTextParams`, `com.nomagic.magicdraw.uml.text.OperationTextParams`, `com.nomagic.magicdraw.uml.text.PropertyTextParams`, `com.nomagic.magicdraw.uml.text.ReceptionTextParams`

#### `setShowStereotypeFromSameWarning(boolean)`

- **Description**: Set if show warnings about not applied stereotypes (from the same profile).
- **Method**: Not Applicable (Method Signature Provided)
- **Class**: `com.nomagic.magicdraw.emfuml2xmi.envoptions.BaseEmfOptionsGroup`

### Parameters

All methods listed above accept a single **boolean** parameter.

- **boolean**: `true` to show the element, `false` to hide it.

### Request Example

```java
// Example usage (conceptual, actual implementation depends on context)
configurationService.setShowMappinWarning(true);
notificationViewConfig.setShowMultipleNotifications(false);
```

### Response

These methods typically do not return a value. Their effect is to modify the application's configuration state.
```

--------------------------------

### Plugin Initialization

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/plugins/Plugin

The `init()` method is called by MagicDraw during startup for plugin initialization.

```APIDOC
## POST /plugin/init

### Description
Plugin initialization method. Every plugin must override this method and do any action related to plugin initialization. For example, registering actions or configurators to the MagicDraw application. This method is called by the MagicDraw application during MagicDraw startup.

### Method
POST

### Endpoint
/plugin/init

### Request Body
This endpoint does not typically take a request body as it's an internal method called by MagicDraw.

### Response
#### Success Response (200)
- **status** (string) - Indicates successful initialization.

#### Response Example
```json
{
  "status": "initialized"
}
```
```

--------------------------------

### init(Project, Constraint)

Source: https://jdocs.nomagic.com/190/index-files/index-9

This is the first method that is invoked on the implementation of the `ValidationRule` interface.

```APIDOC
## init(Project, Constraint)

### Description
This is the first method that is invoked on the implementation of the `ValidationRule` interface.

### Method
(Not specified, likely constructor or initialization method)

### Endpoint
(Not applicable for Java methods)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(Not applicable for Java methods)

### Response
#### Success Response (N/A)
(None)

#### Response Example
(Not applicable for Java methods)
```

--------------------------------

### Get OccurrenceSpecification executionSpecificationOfStart Reference (Java)

Source: https://jdocs.nomagic.com/190/com/nomagic/uml2/ext/magicdraw/interactions/mdbasicinteractions/OccurrenceSpecification

Retrieves the list of ExecutionSpecification objects associated with the start of this OccurrenceSpecification. This is a bidirectional reference, with '_Start_' as its opposite.

```java
java.util.Collection<ExecutionSpecification> get_executionSpecificationOfStart()

```

--------------------------------

### Get Application Cookie Set

Source: https://jdocs.nomagic.com/190/com/nomagic/magicdraw/core/Application

Retrieves the set of cookies used by the application. This set can be manipulated, for example, to replace the default application close cookie with a custom one.

```java
public final CookieSet getCookieSet()
```