## Uses of Interface
com.microfocus.awm.model.toolexecution.IToolContext

- Packages that use IToolContext
  Package | Description
  --- | ---
  com.microfocus.awm.control | Contains basic classes for executing AWM actions, like the ActionExecutor.
  com.microfocus.awm.control.toolexecution |
  com.microfocus.awm.control.toolexecution.internal |
  com.microfocus.awm.core | Contains central helper classes (like TaurusUtility) and basic implementations of AWM interfaces.
  com.microfocus.awm.core.internal.util |
  com.microfocus.awm.internal.functionpackage.awm.tools | Internal AWM tool implementations.
  com.microfocus.awm.internal.functionpackage.oscommand.tools | Internal tool implementations for the Operating System Function Package.
  com.microfocus.awm.model.toolexecution |
  com.microfocus.awm.tools | Internal AWM tool type implementations.
  com.microfocus.awm.utility | Internal helper classes.

- - ### Uses of IToolContext in com.microfocus.awm.control

    Methods in com.microfocus.awm.control with parameters of type IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `static void` | ActionExecutor.`handleFileOutput(IToolContext pToolContext, IExecutionContext pExecutionContext, FileDescriptor targetIDFile, java.lang.Object pOutparmValue)` Handles a returned file output parameter by "describing" the referenced file descriptor and adding it to the parameter memory.

  - ### Uses of IToolContext in com.microfocus.awm.control.toolexecution

    Methods in com.microfocus.awm.control.toolexecution that return IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `IToolContext` | MassOutputEntry.`getSubConntext()`
    `IToolContext` | ToolResult.`getToolContext()`

    Methods in com.microfocus.awm.control.toolexecution with parameters of type IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `void` | ToolOutput.`addOutputParameter(IToolOutputParameter pToolOutputParameter, IToolContext pToolContext)` Adds an output parameter to the tool output.
    `static <T> T` | ToolUtility.`getAttributeValue(IToolContext pContext, IDynamicObject pDynamicObject, java.lang.String pAttributeId, java.lang.Class<T> pAttributeType)` Returns an attribute value of a given model extension object (`IDynamicObject`).
    `static <T extends IToolInputParameter> T` | ToolUtility.`getInputParameter(IToolContext pToolContext, java.lang.String pExtensionID, java.lang.Class<T> pType)` This method retrieves the first found `IToolInputParameter` which extension ID matches the provided extension ID.
    `static <T extends IToolInputParameter> java.util.Collection<T>` | ToolUtility.`getInputParameters(IToolContext pToolContext, java.lang.String pExtensionID, java.lang.Class<T> pType)` This method retrieves a `Collection` of `IToolInputParameter` which extension ID matches the provided extension ID.
    `static <T extends IToolInputParameter> java.util.Collection<T>` | ToolUtility.`getInputParametersByType(IToolContext pToolContext, java.lang.Class<T> pType)` Retrieves all `IToolInputParameter` of a specific parameter type.
    `static <T extends IModeledToolOutputParameter> T` | ToolUtility.`getOutputParameter(IToolContext pToolContext, java.lang.String pExtensionID, java.lang.Class<T> pType)` This method retrieves the first found `IModeledToolOutputParameter` which extension ID matches the provided extension ID.
    `static <T extends IModeledToolOutputParameter> java.util.Collection<T>` | ToolUtility.`getOutputParameters(IToolContext pToolContext, java.lang.String pExtensionID, java.lang.Class<T> pType)` This method retrieves a `Collection` of `IModeledToolOutputParameter` which extension ID matches the provided extension ID.
    `static <T extends IModeledToolOutputParameter> java.util.Collection<T>` | ToolUtility.`getOutputParametersByType(IToolContext pToolContext, java.lang.Class<T> pType)` Retrieves all `IModeledPropertyOutputParameter` of a specific parameter type.
    `static java.lang.String` | AbstractCommandBasedToolExecutor.`getParameterSeparatorWithoutQuotes(IToolContext pToolContext, java.lang.String pParmSeparatorAttributeID)`

    Constructors in com.microfocus.awm.control.toolexecution with parameters of type IToolContext
    Constructor and Description
    `MassOutputEntry(IToolContext pSubContext, java.util.List<IToolOutputParameter> pOutputParameters)` Creates a new mass output entry.
    `ToolResult(IToolContext pToolContext)` Creates a new tool result without a tool message, no output parameters and severity `ToolResultSeverity.OK`.
    `ToolResult(IToolContext pToolContext, IToolOutput pToolOutput)` Creates a new tool result with tool output, no message and severity `ToolResultSeverity.OK`.
    `ToolResult(IToolContext pToolContext, java.lang.String pMessage, IToolResultSeverity pSeverity)` Creates a new tool result with a message and severity.
    `ToolResult(IToolContext pToolContext, java.lang.String pMessage, IToolResultSeverity pSeverity, IToolOutput pToolOutput)` Creates a new tool result with a message, severity and tool output.

  - ### Uses of IToolContext in com.microfocus.awm.control.toolexecution.internal

    Classes in com.microfocus.awm.control.toolexecution.internal that implement IToolContext
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractToolContext` Abstract base implementation of `IToolContext`.
    `class` | `LegacyToolExecutorContext` Tool context for tool executors using the old `IToolExecutor` interface.
    `class` | `MassProcessingSubContext` Standard implementation of `IMassProcessingSubContext`.
    `class` | `MassProcessingToolContext` Standard implementation of `IMassProcessingToolContext`.
    `class` | `SingleProcessingToolContext` Basic tool context implementation for single processing execution.

    Methods in com.microfocus.awm.control.toolexecution.internal that return IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `IToolContext` | MassProcessingSubContext.`getParentContext()`

    Methods in com.microfocus.awm.control.toolexecution.internal that return types with arguments of type IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<IToolContext>` | MassProcessingToolContext.`getSubContexts()`
    `java.util.List<IToolContext>` | LegacyToolExecutorContext.`getSubContexts()`

  - ### Uses of IToolContext in com.microfocus.awm.core

    Methods in com.microfocus.awm.core with parameters of type IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `static IToolInputParameter` | TaurusFactory.`createInputParameter(RToolInParameter pRToolInParameter, IToolContext pToolContext)` Creates a new `IToolInputParameter` instance based on the provided `RToolInParameter` and `IToolContext`.
    `static FileDescriptor` | TaurusModelUtilities.`getFileDescriptorFromParameter(RToolParameter pParm, IToolContext pToolContext)` Resolves and returns a file descriptor referenced by a tool parameter.

  - ### Uses of IToolContext in com.microfocus.awm.core.internal.util

    Methods in com.microfocus.awm.core.internal.util that return IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `IToolContext` | AbstractConvertedToolExecutor.`createToolContext(IExecutionContext pExecutionContext, ToolDescriptor pToolDescriptor, boolean pIsMassProcessing)`

  - ### Uses of IToolContext in com.microfocus.awm.internal.functionpackage.awm.tools

    Methods in com.microfocus.awm.internal.functionpackage.awm.tools that return IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `IToolContext` | ReturnPropertyValue2.`createToolContext(IExecutionContext pExecutionContext, ToolDescriptor pToolDescriptor, boolean pIsMassProcessing)`

    Methods in com.microfocus.awm.internal.functionpackage.awm.tools with parameters of type IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `IToolResult` | ValidateValue.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | ValidateLineLength.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)` Gets the maximum line length Gets the content either from the editor context or a file Validates the content of each line Based on the result, it creates the `ToolExecutionStatus` and puts the `RToolOutParameter` into the `IExecutionContext`.
    `IToolResult` | TransferFile.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | ReturnPropertyValue2.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | MergeStructuredFiles2.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | LocalTempFileCreatorToolExecutor.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | LocalFileLocatorToolExecutor.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | LocalFileCreatorToolExecutor.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | ErrorFeedbackToolExecutor.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | EditCleanUpToolExecutor.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | CreateStructuredFileToolExecutor.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | CreateStaticElementListToolExecutor.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | ClearErrorFeedbackEntriesToolExecutor.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | ClearApplicationFileCacheToolExecutor.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | ChildrenRefresherToolExecutor.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `void` | ValidateValue.`init(IToolContext pToolContext)`
    `void` | ValidateLineLength.`init(IToolContext pToolContext)`
    `void` | MergeStructuredFiles2.`init(IToolContext pToolContext)`
    `void` | CreateStructuredFileToolExecutor.`init(IToolContext pToolContext)`

  - ### Uses of IToolContext in com.microfocus.awm.internal.functionpackage.oscommand.tools

    Methods in com.microfocus.awm.internal.functionpackage.oscommand.tools with parameters of type IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `IToolResult` | OSCommandToolExecutor2.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `IToolResult` | CheckOSFileExistence.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`
    `void` | OSCommandToolExecutor2.`init(IToolContext pToolContext)`
    `void` | CheckOSFileExistence.`init(IToolContext pToolContext)`

  - ### Uses of IToolContext in com.microfocus.awm.model.toolexecution

    Subinterfaces of IToolContext in com.microfocus.awm.model.toolexecution
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `IMassProcessingSubContext` A sub-context of an `IMassProcessingToolContext`.
    `interface` | `IMassProcessingToolContext` An extension of `IToolContext` containing sub-contexts for mass processing execution.

    Methods in com.microfocus.awm.model.toolexecution that return IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `default IToolContext` | IToolExecutor2.`createToolContext(IExecutionContext pExecutionContext, ToolDescriptor pToolDescriptor, boolean pIsMassProcessing)` This method creates a `IToolContext`.
    `IToolContext` | IMassProcessingSubContext.`getParentContext()` Gets the sub-context's parent context.
    `IToolContext` | IMassOutputEntry.`getSubConntext()` Returns the sub-context of this entry.
    `IToolContext` | IToolResult.`getToolContext()` Gets the tool context that was used for executing the tool descriptor.

    Methods in com.microfocus.awm.model.toolexecution that return types with arguments of type IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<IToolContext>` | IMassProcessingToolContext.`getSubContexts()` Returns the list of sub-contexts, representing the resources that are currently processed.

    Methods in com.microfocus.awm.model.toolexecution with parameters of type IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `IToolResult` | IToolExecutor2.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)` Executes the tool for a single resource.
    `default void` | IToolExecutor2.`init(IToolContext pToolContext)` Initializes the tool executor before it is being executed.
    `IToolResult` | IAsynchronousToolExecutor.`parseToolResult(IToolContext pToolContext, java.lang.String pParmFilePath, org.eclipse.core.runtime.IProgressMonitor pMon)` Reads the result of a previously executed tool from the given parameter file path.

  - ### Uses of IToolContext in com.microfocus.awm.tools

    Methods in com.microfocus.awm.tools with parameters of type IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `IToolResult` | LinkedPropertySetter.`executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon)`

  - ### Uses of IToolContext in com.microfocus.awm.utility

    Methods in com.microfocus.awm.utility with parameters of type IToolContext
    Modifier and Type | Method and Description
    --- | ---
    `static <T extends IToolInputParameter> T` | AWMInternalUtility.`findInputParameter(RToolInParameter pInParameter, IToolContext pToolContext, java.lang.Class<T> pType)` Searches for a `IToolInputParameter` in the given `IToolContext` based on the given `RToolInParameter`.
    `static <T extends IModeledToolOutputParameter> T` | AWMInternalUtility.`findOutputParameter(RToolOutParameter pOutParm, IToolContext pToolContext, java.lang.Class<T> pType)` Searches for a `IModeledToolOutputParameter` in the given `IToolContext` based on the given `RToolOutParameter`.
    `static <T extends IToolInputParameter> T` | AWMInternalUtility.`getFirstInputParameterWithFallBack(IToolContext pToolContext, java.lang.String pName, java.lang.Class<T> pType, int pFallBackIndex)` Calls `ToolUtility.getInputParameter(IToolContext, String, Class)` to get a parameter.
    `static <T extends IModeledToolOutputParameter> T` | AWMInternalUtility.`getFirstOutputParameterWithFallBack(IToolContext pToolContext, java.lang.String pName, java.lang.Class<T> pType, int pFallBackIndex)` Calls `ToolUtility.getOutputParameter(IToolContext, String, Class)` to get a parameter.

Copyright © 2015 Micro Focus GmbH. All rights reserved.