com.nomagic.magicdraw.validation

Class ValidationRunData

java.lang.Object

com.nomagic.magicdraw.validation.ValidationRunData

@OpenApiAll
public class ValidationRunData
extends java.lang.Object

Parameters information for validation operation.

Constructor Summary

Constructors

Constructor and Description
ValidationRunData(boolean wholeProject, java.util.Collection<Package> suites, java.util.Collection<Element> elements, EnumerationLiteral severity) Validation data for suites execution.
ValidationRunData(java.util.Collection<Constraint> constraints, java.lang.String name, boolean wholeProject, java.util.Collection<? extends Element> elements, EnumerationLiteral severity, boolean excludeReadOnly) Validation data for specific constraints.
ValidationRunData(java.util.Collection<Package> suites, com.nomagic.magicdraw.validation.Scope scope, EnumerationLiteral severity) Constructs validation run data.
ValidationRunData(Package suite, boolean wholeProject, java.util.Collection<? extends Element> elements, EnumerationLiteral severity) Validation data for whole suite execution.
ValidationRunData(Package suite, boolean wholeProject, java.util.Collection<? extends Element> elements, EnumerationLiteral severity, boolean excludeReadOnly)

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Constraint>	getConstraints() Validation constraints
java.lang.String	getCustomSuccessMessage()
java.util.Collection<Element>	getElements() The selected elements to run validation on.
java.util.Collection<Constraint>	getIgnoredConstraints()
java.lang.String	getName() Gets name of the suite.
Project	getProject() Get project where the validation data is located.
com.nomagic.magicdraw.validation.Scope	getScope() Gets validation scope.
EnumerationLiteral	getSeverity() Minimum validation severity level.
Package	getSuite() Deprecated. use getSuites()
java.util.Collection<Package>	getSuites() Gets suits to be used in validation.
boolean	isAddElementsRecursively() Should validation engine add scope elements recursively, or should it validate only provided scope.
boolean	isEnableSettingsDialog()
boolean	isExcludeReadOnly()
boolean	isTrackActiveDiagrams()
boolean	isWholeProject() Validation is run on whole project
void	setAddElementsRecursively(boolean addElementsRecursively) Should validation engine add scope elements recursively, or should it validate only provided scope.
void	setCustomSuccessMessage(java.lang.String customSuccessMessage) Set custom validation result message.
void	setEnableSettingsDialog(boolean enableSettingsDialog) Disable "Run validation with a new settings" button in the validation results window.
void	setExcludeReadOnly(boolean excludeReadOnly)
void	setIgnoredConstraints(java.util.Collection<Constraint> ignoredConstraints)
void	setTrackActiveDiagrams(boolean trackActiveDiagrams)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValidationRunData

public ValidationRunData(boolean wholeProject,
                         java.util.Collection<Package> suites,
                         @CheckForNull
                         java.util.Collection<Element> elements,
                         @CheckForNull
                         EnumerationLiteral severity)

Validation data for suites execution.

Parameters:

wholeProject - If true - all elements are included.

suites - suites to execute

elements - If wholeProject is false, then execute only on those elements

severity - severity level

ValidationRunData

public ValidationRunData(@CheckForNull
                         Package suite,
                         boolean wholeProject,
                         @CheckForNull
                         java.util.Collection<? extends Element> elements,
                         @CheckForNull
                         EnumerationLiteral severity)

Validation data for whole suite execution.

Parameters:

suite - suite to execute

wholeProject - If true - all elements are included.

elements - If wholeProject is false, then execute only on those elements

severity - severity level

ValidationRunData

public ValidationRunData(@CheckForNull
                         Package suite,
                         boolean wholeProject,
                         @CheckForNull
                         java.util.Collection<? extends Element> elements,
                         @CheckForNull
                         EnumerationLiteral severity,
                         boolean excludeReadOnly)

Parameters:

suite - to execute.

wholeProject - if true all elements are included.

elements - if wholeProject is false, then execute only on those elements.

severity - level.

excludeReadOnly - elements from execution?

ValidationRunData

public ValidationRunData(java.util.Collection<Package> suites,
                         com.nomagic.magicdraw.validation.Scope scope,
                         EnumerationLiteral severity)

Constructs validation run data.

Parameters:

suites - suites from which to take constraints.

scope - scope to validate.

severity - validation severity level.

ValidationRunData

public ValidationRunData(@Nonnull
                         java.util.Collection<Constraint> constraints,
                         java.lang.String name,
                         boolean wholeProject,
                         @CheckForNull
                         java.util.Collection<? extends Element> elements,
                         @CheckForNull
                         EnumerationLiteral severity,
                         boolean excludeReadOnly)

Validation data for specific constraints.

Parameters:

constraints - constraints to run

name - name for rule collection (like suite name)

wholeProject - If true - all elements are included.

elements - If wholeProject is false, then execute only on those elements

severity - severity level

excludeReadOnly - exclude readonly elements from execution (dialog setting)

Method Detail

isEnableSettingsDialog

public boolean isEnableSettingsDialog()

setEnableSettingsDialog

public void setEnableSettingsDialog(boolean enableSettingsDialog)

Disable "Run validation with a new settings" button in the validation results window. Default value - true;

Parameters:

enableSettingsDialog - value

setCustomSuccessMessage

public void setCustomSuccessMessage(java.lang.String customSuccessMessage)

Set custom validation result message. If null - default is shown.

Parameters:

customSuccessMessage - Message text

getCustomSuccessMessage

public java.lang.String getCustomSuccessMessage()

setExcludeReadOnly

public void setExcludeReadOnly(boolean excludeReadOnly)

isExcludeReadOnly

public boolean isExcludeReadOnly()

getName

public java.lang.String getName()

Gets name of the suite. If suite was not assigned, then name value returned be defined by the constructor.

Returns:

name of the suite (constraint collection)

getSuite

@Deprecated
 @CheckForNull
public Package getSuite()

Deprecated. use getSuites()

The suite of constraints to run on some target elements.

Returns:

suite

getSuites

public java.util.Collection<Package> getSuites()

Gets suits to be used in validation.

Returns:

suits to be used in validation.

getElements

public java.util.Collection<Element> getElements()

The selected elements to run validation on.

Returns:

scope

getSeverity

public EnumerationLiteral getSeverity()

Minimum validation severity level.

Returns:

severity

getConstraints

public java.util.Collection<Constraint> getConstraints()

Validation constraints

Returns:

constraints. either from suite, either internal.

isWholeProject

public boolean isWholeProject()

Validation is run on whole project

Returns:

will run on whole project

getProject

public Project getProject()

Get project where the validation data is located. Returns null if no suite or constraints specified.

Returns:

validation suite/rule parent project

isAddElementsRecursively

public boolean isAddElementsRecursively()

Should validation engine add scope elements recursively, or should it validate only provided scope. Default is true

Returns:

true if elements should be added recursively

setAddElementsRecursively

public void setAddElementsRecursively(boolean addElementsRecursively)

Should validation engine add scope elements recursively, or should it validate only provided scope. Default is true

Parameters:

addElementsRecursively - true if elements should be added recursively

getScope

public com.nomagic.magicdraw.validation.Scope getScope()

Gets validation scope.

Returns:

validation scope.

setIgnoredConstraints

public void setIgnoredConstraints(java.util.Collection<Constraint> ignoredConstraints)

getIgnoredConstraints

public java.util.Collection<Constraint> getIgnoredConstraints()

isTrackActiveDiagrams

public boolean isTrackActiveDiagrams()

setTrackActiveDiagrams

public void setTrackActiveDiagrams(boolean trackActiveDiagrams)