## Uses of Interface
de.gebit.integrity.dsl.SuiteDefinition

- Packages that use SuiteDefinition
  Package | Description
  --- | ---
  de.gebit.integrity.dsl |
  de.gebit.integrity.dsl.impl |
  de.gebit.integrity.dsl.util |
  de.gebit.integrity.runner |
  de.gebit.integrity.runner.callbacks |
  de.gebit.integrity.runner.callbacks.console |
  de.gebit.integrity.runner.callbacks.remoting |
  de.gebit.integrity.runner.callbacks.xml |
  de.gebit.integrity.runner.console |
  de.gebit.integrity.runner.results |
  de.gebit.integrity.serializer |
  de.gebit.integrity.ui.contentassist |
  de.gebit.integrity.ui.outline |
  de.gebit.integrity.ui.search |
  de.gebit.integrity.utils |
  de.gebit.integrity.validation |

- - ### Uses of SuiteDefinition in de.gebit.integrity.dsl

    Methods in de.gebit.integrity.dsl that return SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `SuiteDefinition` | DslFactory.`createSuiteDefinition()` | Returns a new object of class 'Suite Definition'.
    `SuiteDefinition` | Suite.`getDefinition()` | Returns the value of the 'Definition' reference.

    Methods in de.gebit.integrity.dsl that return types with arguments of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `org.eclipse.emf.common.util.EList<SuiteDefinition>` | SuiteDefinition.`getDependencies()` | Returns the value of the 'Dependencies' reference list.
    `org.eclipse.emf.common.util.EList<SuiteDefinition>` | SuiteDefinition.`getFinalizers()` | Returns the value of the 'Finalizers' reference list.

    Methods in de.gebit.integrity.dsl with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | Suite.`setDefinition​(SuiteDefinition value)` | Sets the value of the '`Definition`' reference.

  - ### Uses of SuiteDefinition in de.gebit.integrity.dsl.impl

    Classes in de.gebit.integrity.dsl.impl that implement SuiteDefinition
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `SuiteDefinitionImpl` | An implementation of the model object 'Suite Definition'.

    Fields in de.gebit.integrity.dsl.impl declared as SuiteDefinition
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected SuiteDefinition` | SuiteImpl.`definition` | The cached value of the '`Definition`' reference.

    Fields in de.gebit.integrity.dsl.impl with type parameters of type SuiteDefinition
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected org.eclipse.emf.common.util.EList<SuiteDefinition>` | SuiteDefinitionImpl.`dependencies` | The cached value of the '`Dependencies`' reference list.
    `protected org.eclipse.emf.common.util.EList<SuiteDefinition>` | SuiteDefinitionImpl.`finalizers` | The cached value of the '`Finalizers`' reference list.

    Methods in de.gebit.integrity.dsl.impl that return SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `SuiteDefinition` | SuiteImpl.`basicGetDefinition()`
    `SuiteDefinition` | DslFactoryImpl.`createSuiteDefinition()`
    `SuiteDefinition` | SuiteImpl.`getDefinition()`

    Methods in de.gebit.integrity.dsl.impl that return types with arguments of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `org.eclipse.emf.common.util.EList<SuiteDefinition>` | SuiteDefinitionImpl.`getDependencies()`
    `org.eclipse.emf.common.util.EList<SuiteDefinition>` | SuiteDefinitionImpl.`getFinalizers()`

    Methods in de.gebit.integrity.dsl.impl with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | SuiteImpl.`setDefinition​(SuiteDefinition newDefinition)`

  - ### Uses of SuiteDefinition in de.gebit.integrity.dsl.util

    Methods in de.gebit.integrity.dsl.util with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `T` | DslSwitch.`caseSuiteDefinition​(SuiteDefinition object)` | Returns the result of interpreting the object as an instance of 'Suite Definition'.

  - ### Uses of SuiteDefinition in de.gebit.integrity.runner

    Fields in de.gebit.integrity.runner with type parameters of type SuiteDefinition
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Map<ForkDefinition,​Set<SuiteDefinition>>` | DefaultTestRunner.`setupSuitesExecuted` | The setup suites that have been executed.
    `protected Set<SuiteDefinition>` | DefaultTestRunner.`singleRunSuitesExecuted` | The single-run suites that have already been executed.
    `protected Map<String,​SuiteDefinition>` | TestModel.`suiteMap` | Suite names -> Suites.

    Methods in de.gebit.integrity.runner that return SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `SuiteDefinition` | TestModel.`getSuiteByName​(String aFullyQualifiedSuiteName)` | Resolves a fully qualified suite name to the actual suite definition.

    Methods in de.gebit.integrity.runner that return types with arguments of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected List<SuiteDefinition>` | DefaultTestRunner.`executeSetupSuites​(SuiteDefinition aSuite, Map<SuiteDefinition,​Result> aSetupResultMap)` | Executes the provided suite as a setup suite.
    `Collection<SuiteDefinition>` | TestModel.`getAllSuites()` | Returns all suites in the test model.

    Methods in de.gebit.integrity.runner with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected void` | DefaultTestRunner.`defineConstant​(ConstantDefinition aDefinition, SuiteDefinition aSuite)` | Defines a constant.
    `protected void` | DefaultTestRunner.`defineConstant​(ConstantDefinition aDefinition, Object aValue, SuiteDefinition aSuite)` | Defines a constant.
    `protected void` | DefaultTestRunner.`defineVariable​(VariableDefinition aDefinition, SuiteDefinition aSuite)` | Defines a variable.
    `protected void` | DefaultTestRunner.`defineVariable​(VariableOrConstantEntity anEntity, Object anInitialValue, SuiteDefinition aSuite)` | Defines a variable.
    `protected List<SuiteDefinition>` | DefaultTestRunner.`executeSetupSuites​(SuiteDefinition aSuite, Map<SuiteDefinition,​Result> aSetupResultMap)` | Executes the provided suite as a setup suite.
    `protected Map<SuiteStatementWithResult,​List<? extends Result>>` | DefaultTestRunner.`executeSuite​(SuiteDefinition aSuite)` | Executes a suite.
    `protected void` | DefaultTestRunner.`executeVariableAssignment​(VariableAssignment anAssignment, SuiteDefinition aSuite)` | Executes variable assignments.
    `SuiteSummaryResult` | DefaultTestRunner.`run​(SuiteDefinition aRootSuite, VariantDefinition aVariant, boolean aBlockForRemotingFlag)` |
    `SuiteSummaryResult` | TestRunner.`run​(SuiteDefinition aRootSuite, VariantDefinition aVariant, boolean aBlockForRemotingFlag)` | Executes a specified suite.

    Method parameters in de.gebit.integrity.runner with type arguments of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected List<SuiteDefinition>` | DefaultTestRunner.`executeSetupSuites​(SuiteDefinition aSuite, Map<SuiteDefinition,​Result> aSetupResultMap)` | Executes the provided suite as a setup suite.
    `protected void` | DefaultTestRunner.`executeTearDownSuites​(List<SuiteDefinition> aSetupSuitesList, Map<SuiteDefinition,​Result> aTearDownResultMap)` | Executes the teardown suites required by the provided setup suites.
    `protected void` | DefaultTestRunner.`executeTearDownSuites​(List<SuiteDefinition> aSetupSuitesList, Map<SuiteDefinition,​Result> aTearDownResultMap)` | Executes the teardown suites required by the provided setup suites.

  - ### Uses of SuiteDefinition in de.gebit.integrity.runner.callbacks

    Methods in de.gebit.integrity.runner.callbacks with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | CompoundTestRunnerCallback.`onConstantDefinition​(ConstantEntity aDefinition, SuiteDefinition aSuite, Object aValue, boolean aParameterizedFlag)` |
    `abstract void` | TestRunnerCallback.`onConstantDefinition​(ConstantEntity aDefinition, SuiteDefinition aSuite, Object aValue, boolean aParameterizedFlag)` | Called when a constant is being defined.
    `void` | CompoundTestRunnerCallback.`onSetupFinish​(SuiteDefinition aSetupSuite, SuiteResult aResult)` |
    `abstract void` | TestRunnerCallback.`onSetupFinish​(SuiteDefinition aSetupSuite, SuiteResult aResult)` | Called when a setup suite has been executed.
    `void` | CompoundTestRunnerCallback.`onSetupSkipped​(SuiteDefinition aSetupSuite, SuiteSkipReason aReason)` |
    `abstract void` | TestRunnerCallback.`onSetupSkipped​(SuiteDefinition aSetupSuite, SuiteSkipReason aReason)` | Called when a setup suite is being skipped.
    `void` | CompoundTestRunnerCallback.`onSetupStart​(SuiteDefinition aSetupSuite)` |
    `abstract void` | TestRunnerCallback.`onSetupStart​(SuiteDefinition aSetupSuite)` | Called when a setup suite is being called.
    `void` | CompoundTestRunnerCallback.`onTearDownFinish​(SuiteDefinition aTearDownSuite, SuiteResult aResult)` |
    `abstract void` | TestRunnerCallback.`onTearDownFinish​(SuiteDefinition aTearDownSuite, SuiteResult aResult)` | Called after a teardown suite was executed.
    `void` | CompoundTestRunnerCallback.`onTearDownSkipped​(SuiteDefinition aTearDownSuite, SuiteSkipReason aReason)` |
    `abstract void` | TestRunnerCallback.`onTearDownSkipped​(SuiteDefinition aTearDownSuite, SuiteSkipReason aReason)` | Called when a teardown suite is being skipped.
    `void` | CompoundTestRunnerCallback.`onTearDownStart​(SuiteDefinition aTearDownSuite)` |
    `abstract void` | TestRunnerCallback.`onTearDownStart​(SuiteDefinition aTearDownSuite)` | Called before a teardown suite is being executed.
    `void` | CompoundTestRunnerCallback.`onTimeSetStart​(TimeSet aTimeSet, SuiteDefinition aSuite, List<ForkDefinition> someForks)` |
    `abstract void` | TestRunnerCallback.`onTimeSetStart​(TimeSet aTimeSet, SuiteDefinition aSuite, List<ForkDefinition> someForks)` | Called when the test time will be set.
    `void` | CompoundTestRunnerCallback.`onVariableAssignment​(VariableAssignment anAssignment, VariableEntity aDefinition, SuiteDefinition aSuite, Object aValue)` |
    `abstract void` | TestRunnerCallback.`onVariableAssignment​(VariableAssignment anAssignment, VariableEntity aDefinition, SuiteDefinition aSuite, Object aValue)` | Called when a variable is being assigned.
    `void` | CompoundTestRunnerCallback.`onVariableDefinition​(VariableEntity aDefinition, SuiteDefinition aSuite, Object anInitialValue)` |
    `abstract void` | TestRunnerCallback.`onVariableDefinition​(VariableEntity aDefinition, SuiteDefinition aSuite, Object anInitialValue)` | Called when a variable is being defined.

  - ### Uses of SuiteDefinition in de.gebit.integrity.runner.callbacks.console

    Methods in de.gebit.integrity.runner.callbacks.console with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | ConsoleTestCallback.`onConstantDefinition​(ConstantEntity aDefinition, SuiteDefinition aSuite, Object aValue, boolean aParameterizedFlag)` |
    `void` | ConsoleTestCallback.`onSetupFinish​(SuiteDefinition aSetupSuite, SuiteResult aResult)` |
    `void` | ConsoleTestCallback.`onSetupSkipped​(SuiteDefinition aSetupSuite, SuiteSkipReason aReason)` |
    `void` | ConsoleTestCallback.`onSetupStart​(SuiteDefinition aSetupSuite)` |
    `void` | ConsoleTestCallback.`onTearDownFinish​(SuiteDefinition aTearDownSuite, SuiteResult aResult)` |
    `void` | ConsoleTestCallback.`onTearDownSkipped​(SuiteDefinition aTearDownSuite, SuiteSkipReason aReason)` |
    `void` | ConsoleTestCallback.`onTearDownStart​(SuiteDefinition aTearDownSuite)` |
    `void` | ConsoleTestCallback.`onTimeSetStart​(TimeSet aTimeSet, SuiteDefinition aSuite, List<ForkDefinition> someForks)` |
    `void` | ConsoleTestCallback.`onVariableAssignment​(VariableAssignment anAssignment, VariableEntity aDefinition, SuiteDefinition aSuite, Object aValue)` |
    `void` | ConsoleTestCallback.`onVariableDefinition​(VariableEntity aDefinition, SuiteDefinition aSuite, Object anInitialValue)` |

  - ### Uses of SuiteDefinition in de.gebit.integrity.runner.callbacks.remoting

    Methods in de.gebit.integrity.runner.callbacks.remoting with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | SetListCallback.`onConstantDefinition​(ConstantEntity aDefinition, SuiteDefinition aSuite, Object aValue, boolean aParameterizedFlag)` |
    `void` | SetListCallback.`onSetupFinish​(SuiteDefinition aSetupSuite, SuiteResult aResult)` |
    `void` | SetListCallback.`onSetupSkipped​(SuiteDefinition aSetupSuite, SuiteSkipReason aReason)` |
    `void` | SetListCallback.`onSetupStart​(SuiteDefinition aSetupSuite)` |
    `void` | SetListCallback.`onTearDownFinish​(SuiteDefinition aTearDownSuite, SuiteResult aResult)` |
    `void` | SetListCallback.`onTearDownSkipped​(SuiteDefinition aTearDownSuite, SuiteSkipReason aReason)` |
    `void` | SetListCallback.`onTearDownStart​(SuiteDefinition aTearDownSuite)` |
    `void` | SetListCallback.`onTimeSetStart​(TimeSet aTimeSet, SuiteDefinition aSuite, List<ForkDefinition> someForks)` |
    `void` | SetListCallback.`onVariableAssignment​(VariableAssignment anAssignment, VariableEntity aVariableEntity, SuiteDefinition aSuite, Object aValue)` |
    `void` | SetListCallback.`onVariableDefinition​(VariableEntity aDefinition, SuiteDefinition aSuite, Object anInitialValue)` |

  - ### Uses of SuiteDefinition in de.gebit.integrity.runner.callbacks.xml

    Methods in de.gebit.integrity.runner.callbacks.xml with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | XmlWriterTestCallback.`onConstantDefinition​(ConstantEntity aDefinition, SuiteDefinition aSuite, Object aValue, boolean aParameterizedFlag)` | On constant definition.
    `void` | XmlWriterTestCallback.`onSetupFinish​(SuiteDefinition aSetupSuite, SuiteResult aResult)` | On setup finish.
    `void` | XmlWriterTestCallback.`onSetupSkipped​(SuiteDefinition aSetupSuite, SuiteSkipReason aReason)` |
    `void` | XmlWriterTestCallback.`onSetupStart​(SuiteDefinition aSetupSuite)` | On setup start.
    `void` | XmlWriterTestCallback.`onTearDownFinish​(SuiteDefinition aTearDownSuite, SuiteResult aResult)` | On tear down finish.
    `void` | XmlWriterTestCallback.`onTearDownSkipped​(SuiteDefinition aTearDownSuite, SuiteSkipReason aReason)` |
    `void` | XmlWriterTestCallback.`onTearDownStart​(SuiteDefinition aTearDownSuite)` | On tear down start.
    `void` | XmlWriterTestCallback.`onTimeSetStart​(TimeSet aTimeSet, SuiteDefinition aSuite, List<ForkDefinition> someForks)` |
    `void` | XmlWriterTestCallback.`onVariableAssignment​(VariableAssignment anAssignment, VariableEntity aDefinition, SuiteDefinition aSuite, Object aValue)` |
    `void` | XmlWriterTestCallback.`onVariableDefinition​(VariableEntity aDefinition, SuiteDefinition aSuite, Object anInitialValue)` | On variable definition.

  - ### Uses of SuiteDefinition in de.gebit.integrity.runner.console

    Methods in de.gebit.integrity.runner.console with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected void` | ConsoleTestExecutor.`runTests​(TestRunner aRunner, SuiteDefinition aRootSuite, VariantDefinition aVariant, boolean aBlockForRemotingFlag)` | Run the tests on the provided `TestRunner`.

  - ### Uses of SuiteDefinition in de.gebit.integrity.runner.results

    Methods in de.gebit.integrity.runner.results that return types with arguments of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `Map<SuiteDefinition,​Result>` | SuiteResult.`getSetupResults()` |
    `Map<SuiteDefinition,​Result>` | SuiteResult.`getTearDownResults()` |

  - ### Uses of SuiteDefinition in de.gebit.integrity.serializer

    Methods in de.gebit.integrity.serializer with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected void` | AbstractDSLSemanticSequencer.`sequence_SuiteDefinition​(org.eclipse.xtext.serializer.ISerializationContext context, SuiteDefinition semanticObject)` | Contexts: PackageStatement returns SuiteDefinition SuiteDefinition returns SuiteDefinition Constraint: ( documentation=DocumentationComment? private='private'? singleRun='single-run'? inlined='inlined'? name=QualifiedName parameters+=SuiteParameterDefinition* return+=SuiteReturnDefinition* dependencies+=[SuiteDefinition|QualifiedName]* finalizers+=[SuiteDefinition|QualifiedName]* statements+=SuiteStatement* )

  - ### Uses of SuiteDefinition in de.gebit.integrity.ui.contentassist

    Methods in de.gebit.integrity.ui.contentassist that return SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `SuiteDefinition` | IntegrityConfigurableCompletionProposal.`getSuiteDefiningProposedParameter()` |

  - ### Uses of SuiteDefinition in de.gebit.integrity.ui.outline

    Methods in de.gebit.integrity.ui.outline with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | DSLOutlineTreeProvider.`_createChildren​(org.eclipse.xtext.ui.editor.outline.IOutlineNode aParent, SuiteDefinition aSuiteDefinition)` | Dynamic Dispatch of `DefaultOutlineTreeProvider.createChildren(IOutlineNode, EObject)`.
    `protected void` | DSLOutlineTreeProvider.`_createNode​(org.eclipse.xtext.ui.editor.outline.IOutlineNode aParentNode, SuiteDefinition aSuiteDefinition)` | Dynamic Dispatch of `DefaultOutlineTreeProvider.createNode(IOutlineNode, EObject)`.
    `protected org.eclipse.swt.graphics.Image` | DSLOutlineTreeProvider.`_image​(SuiteDefinition aSuite)` | Dynamic Dispatch of `DefaultOutlineTreeProvider._image(Object)`.
    `protected org.eclipse.jface.viewers.StyledString` | DSLOutlineTreeProvider.`_text​(SuiteDefinition aSuiteDefinition)` | Dynamic Dispatch of `DefaultOutlineTreeProvider._text(Object)`.
    `protected org.eclipse.xtext.ui.editor.outline.impl.EObjectNode` | DSLOutlineTreeProvider.`createSuiteNode​(org.eclipse.xtext.ui.editor.outline.IOutlineNode aParentNode, SuiteDefinition aSuiteDefinition, DSLOutlineTreeProvider.SuiteType aType)` | Creates a Suite Node, which is a special case because there are multiple types of suite nodes and we need to know this type before, as the node itself is unaware of it's type.
    `protected org.eclipse.jface.viewers.StyledString` | DSLOutlineTreeProvider.`text​(SuiteDefinition aSuiteDefinition, DSLOutlineTreeProvider.SuiteType aType)` | Returns a styled textual representation of the given suite definition.

  - ### Uses of SuiteDefinition in de.gebit.integrity.ui.search

    Methods in de.gebit.integrity.ui.search that return SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `SuiteDefinition[]` | DefaultIntegritySearch.`findSuiteDefinitionByName​(String aSuiteName)` |
    `SuiteDefinition[]` | IntegritySearch.`findSuiteDefinitionByName​(String aSuiteName)` | Finds a suite definition by name (fullyqualified or part of the suite name).

  - ### Uses of SuiteDefinition in de.gebit.integrity.utils

    Methods in de.gebit.integrity.utils that return SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `static SuiteDefinition` | IntegrityDSLUtil.`getSuiteContaining​(org.eclipse.emf.ecore.EObject anObject)` | Finds the `SuiteDefinition` that contains the given `EObject`.

    Methods in de.gebit.integrity.utils with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `static String` | IntegrityDSLUtil.`getQualifiedSuiteName​(SuiteDefinition aSuite)` | Returns the fully qualified name of a given `SuiteDefinition`.
    `static String` | IntegrityDSLUtil.`getSuiteTitle​(SuiteDefinition aSuite)` | Gets the suites' title from a given suite.
    `static List<VariableEntity>` | ParameterUtil.`getVariableEntitiesForSuiteParameters​(SuiteDefinition aSuite)` | Determines a list of all `VariableEntity`s referenced in a suites' parameter list.

  - ### Uses of SuiteDefinition in de.gebit.integrity.validation

    Methods in de.gebit.integrity.validation with parameters of type SuiteDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | DSLJavaValidator.`checkIfSuiteDefinitionsAreValid​(SuiteDefinition anEntity)` | Checks whether a definition contains dots, which would be illegal (issue #174).