## Uses of Interface
com.microfocus.awm.meta.interfaces.ActionDescriptor

- Packages that use ActionDescriptor
  Package | Description
  --- | ---
  com.microfocus.awm.control | Contains basic classes for executing AWM actions, like the ActionExecutor.
  com.microfocus.awm.core | Contains central helper classes (like TaurusUtility) and basic implementations of AWM interfaces.
  com.microfocus.awm.meta | Core classes of the AWM meta model plug-in.
  com.microfocus.awm.meta.impl | Implementations of AWM model access interfaces.
  com.microfocus.awm.meta.interfaces | Provides access to the AWM modeled data like AWM action descriptors, application options, element list structures, element types, file descriptors, filter types, function packages, global actions, icons, tool descriptors, and so on.
  com.microfocus.awm.meta.interfaces.validation | Internal validation interfaces for objects of the AWM meta model.
  com.microfocus.awm.meta.util | Helper and utility classes for the AWM meta model including model validation and conversion.
  com.microfocus.awm.model | Contains interfaces which provide access to AWM managed resources at run-time like AWM applications, elements, element lists, filters, file descriptors, actions, tools, properties and the master configuration, and so on.
  com.microfocus.awm.model.internal | Internal implementations of AWM interfaces.

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

    Methods in com.microfocus.awm.control that return ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `ActionDescriptor` | ActionExecutorResult.`getActionDescriptor()` Gets the the action descriptor of the executed action.
    `ActionDescriptor` | ActionExecutor.`getActionDescriptor()` Gets the the `ActionDescriptor` of the action executor instance.

    Methods in com.microfocus.awm.control with parameters of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `static java.lang.String` | ActionExecutor.`createActionExecutionExceptionMessage(ActionDescriptor pActDescr)` Creates a general error message when the execution of an action descriptor fails with an exception.
    `static java.lang.String` | ActionExecutor.`createActionExecutionExceptionMessage(ActionDescriptor pActDescr, java.lang.Throwable pE)` Creates a general error message when the execution of an action descriptor fails with an exception.
    `static IAction` | ActionExecutor.`executeAction(IExecutionContext pActionContext, ActionDescriptor pActDesc, org.eclipse.core.runtime.IProgressMonitor pMon)` Deprecated. Not thread safe and doesn't throw exceptions. Use any of the create(...) methods to create an action executor instance and then `ActionExecutor.execute(IProgressMonitor)` instead.
    `static IAction` | ActionExecutor.`executeAction(ISystemImage pImg, IResource pRes, ActionDescriptor pTauAction, org.eclipse.core.runtime.IProgressMonitor pMon)` Deprecated. Not thread safe and doesn't throw exceptions. Use any of the create(...) methods to create an action executor instance and then `ActionExecutor.execute(IProgressMonitor)` instead.
    `static IAction` | ActionExecutor.`executeAction(ISystemImage pImg, java.util.List<IResource> pResources, ActionDescriptor pActDescr, org.eclipse.core.runtime.IProgressMonitor pMon)` Deprecated. Not thread safe and doesn't throw exceptions. Use any of the create(...) methods to create an action executor instance and then `ActionExecutor.execute(IProgressMonitor)` instead.
    `static void` | ElementlistManager.`fillElementList(ToolDescriptor pTd, IElementList pElementList, ActionDescriptor filActDescr, IExecutionContext pContext)` Finds the file output parameter from the given tool descriptor and converts the physical element list into element list entries.
    `static void` | ActionExecutor.`handleActionExcecutionException(TaurusException pExpception, ActionDescriptor pActDescr, IExecutionContext pContext)` Handles how the given exception occurred during execution of the given action descriptor should be processed.
    `static IElementList` | ElementListController.`restoreList(ActionDescriptor pAct, IResource pRes)` Deprecated. Call `IElementListDirectory.restoreList(ActionDescriptor, IResource)`.

    Constructors in com.microfocus.awm.control with parameters of type ActionDescriptor
    Constructor and Description
    `ActionExecutor(ActionDescriptor pActDescr, IExecutionContext pContext)` Basic constructor.
    `ActionExecutor(ActionDescriptor pActDescr, ISystemImage pImg, IResource pRes)` Creates an ActionExecutor instance with a single `IResource` as context.
    `ActionExecutor(ActionDescriptor pActDescr, ISystemImage pImg, java.util.List<IResource> pResources)` Creates an ActionExecutor instance with multiple `IResource`s as context.

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

    Methods in com.microfocus.awm.core that return ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `ActionDescriptor` | TaurusFactory.`getAction(java.lang.String pActionID)` Gets the action descriptor with the given ID from the currently loaded model.
    `static ActionDescriptor` | TaurusModelUtilities.`getActionDescriptorByID(java.lang.String pID, TAURUSConfiguration pTauConf)` Returns the Action Descriptor with the given ID in the given Taurus model configuration.
    `static ActionDescriptor` | TaurusModelUtilities.`getAfterJobAction(ToolDescriptor pTool)` Gets "job after action" of the tool descriptor supporting both old tool types (old extension points) and new ones (function packages).
    `static ActionDescriptor` | TaurusModelUtilities.`getDefaultFilterAction(IFilter pFilter)` Get the default filter action for the given filter.
    `static ActionDescriptor` | TaurusModelUtilities.`getGetRootContainersAction(ITaurusApplication appl)` Safely tries to get the "get root containers" action for the given application.

    Methods in com.microfocus.awm.core with parameters of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `IElementList` | TaurusFactory.`createElementList(ElementListStructure pElementListStructure, ActionDescriptor pAction)` Same as calling `createElementList(ElementListStructure, ActionDescriptor, null, null)`.
    `IElementList` | TaurusFactory.`createElementList(ElementListStructure pElementListStructure, ActionDescriptor pAction, java.lang.String pElementListID)` Same as calling `createElementList(ElementListStructure, ActionDescriptor, String, null)`.
    `IElementList` | TaurusFactory.`createElementList(ElementListStructure pElementListStructure, ActionDescriptor pAction, java.lang.String pElementListID, IResource pParent)` Creates an `IElementList` depending on the given parent `IResource`.
    `IElementListKey` | TaurusFactory.`createElementListKey(ActionDescriptor pAction, IResource pResource)` Creates an element list key.
    `IExecutionContext` | TaurusFactory.`createExecutionContext(ISystemImage pSys, ActionDescriptor pActionDescriptor)` Creates an execution context.

  - ### Uses of ActionDescriptor in com.microfocus.awm.meta

    Methods in com.microfocus.awm.meta that return ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `ActionDescriptor` | TaurusFactory.`createActionDescriptor()` Returns a new object of class 'Action Descriptor'.

  - ### Uses of ActionDescriptor in com.microfocus.awm.meta.impl

    Classes in com.microfocus.awm.meta.impl that implement ActionDescriptor
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ActionDescriptorImpl`

    Methods in com.microfocus.awm.meta.impl that return ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `ActionDescriptor` | ToolDescriptorImpl.`basicGetAfterJobAction()`
    `ActionDescriptor` | ActionDescriptorImpl.`basicGetRelatedCloseAction()`
    `ActionDescriptor` | ActionDescriptorImpl.`basicGetRelatedSaveAction()`
    `ActionDescriptor` | PropertyImpl.`basicGetRetrieveAllValues()`
    `ActionDescriptor` | ApplicationOptionsImpl.`basicGetRootContainersAction()`
    `ActionDescriptor` | RToolValidateActionImpl.`basicGetTargetID()`
    `ActionDescriptor` | RFilterActionImpl.`basicGetTargetID()`
    `ActionDescriptor` | RFileActionImpl.`basicGetTargetID()`
    `ActionDescriptor` | RErrorViewActionImpl.`basicGetTargetID()`
    `ActionDescriptor` | RElementlistActionImpl.`basicGetTargetID()`
    `ActionDescriptor` | RElementActionBaseImpl.`basicGetTargetID()`
    `ActionDescriptor` | RApplicationActionImpl.`basicGetTargetID()`
    `ActionDescriptor` | GlobalActionImpl.`basicGetTargetID()`
    `ActionDescriptor` | ActionDescriptorImpl.`clone()`
    `ActionDescriptor` | TaurusFactoryImpl.`createActionDescriptor()`
    `ActionDescriptor` | ToolDescriptorImpl.`getAfterJobAction()`
    `ActionDescriptor` | ElementTypeImpl.`getGetAllProperties()`
    `ActionDescriptor` | ElementTypeImpl.`getGetChildren()`
    `ActionDescriptor` | ActionDescriptorImpl.`getRelatedCloseAction()`
    `ActionDescriptor` | ActionDescriptorImpl.`getRelatedSaveAction()`
    `ActionDescriptor` | PropertyImpl.`getRetrieveAllValues()`
    `ActionDescriptor` | ApplicationOptionsImpl.`getRootContainersAction()`
    `ActionDescriptor` | RToolValidateActionImpl.`getTargetID()`
    `ActionDescriptor` | RFilterActionImpl.`getTargetID()`
    `ActionDescriptor` | RFileActionImpl.`getTargetID()`
    `ActionDescriptor` | RErrorViewActionImpl.`getTargetID()`
    `ActionDescriptor` | RElementlistActionImpl.`getTargetID()`
    `ActionDescriptor` | RElementActionBaseImpl.`getTargetID()`
    `ActionDescriptor` | RApplicationActionImpl.`getTargetID()`
    `ActionDescriptor` | GlobalActionImpl.`getTargetID()`

    Methods in com.microfocus.awm.meta.impl that return types with arguments of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `org.eclipse.emf.common.util.EList<ActionDescriptor>` | CActionDescriptorsImpl.`getActionDescriptor()`
    `org.eclipse.emf.common.util.EList<ActionDescriptor>` | ISAISPFPanelImpl.`getHasAction()`

    Methods in com.microfocus.awm.meta.impl with parameters of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `void` | ToolDescriptorImpl.`setAfterJobAction(ActionDescriptor newAfterJobAction)`
    `void` | ElementTypeImpl.`setGetAllProperties(ActionDescriptor pValue)`
    `void` | ActionDescriptorImpl.`setRelatedCloseAction(ActionDescriptor newRelatedCloseAction)`
    `void` | ActionDescriptorImpl.`setRelatedSaveAction(ActionDescriptor newRelatedSaveAction)`
    `void` | PropertyImpl.`setRetrieveAllValues(ActionDescriptor newRetrieveAllValues)`
    `void` | ApplicationOptionsImpl.`setRootContainersAction(ActionDescriptor newRootContainersAction)`
    `void` | RToolValidateActionImpl.`setTargetID(ActionDescriptor newTargetID)`
    `void` | RFilterActionImpl.`setTargetID(ActionDescriptor newTargetID)`
    `void` | RFileActionImpl.`setTargetID(ActionDescriptor newTargetID)`
    `void` | RErrorViewActionImpl.`setTargetID(ActionDescriptor newTargetID)`
    `void` | RElementlistActionImpl.`setTargetID(ActionDescriptor newTargetID)`
    `void` | RElementActionBaseImpl.`setTargetID(ActionDescriptor newTargetID)`
    `void` | RApplicationActionImpl.`setTargetID(ActionDescriptor newTargetID)`
    `void` | GlobalActionImpl.`setTargetID(ActionDescriptor newTargetID)`

  - ### Uses of ActionDescriptor in com.microfocus.awm.meta.interfaces

    Methods in com.microfocus.awm.meta.interfaces that return ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `ActionDescriptor` | ActionDescriptor.`clone()` Clones this action descriptor.
    `ActionDescriptor` | ToolDescriptor.`getAfterJobAction()` Returns the value of the 'After Job Action' reference.
    `ActionDescriptor` | ElementType.`getGetAllProperties()` Deprecated. use `, RElementGetProperties#getTargetID()` instead
    `ActionDescriptor` | ElementType.`getGetChildren()` Returns the value of the 'Get Children' reference.
    `ActionDescriptor` | ActionDescriptor.`getRelatedCloseAction()` Returns the value of the 'Related Close Action' reference.
    `ActionDescriptor` | ActionDescriptor.`getRelatedSaveAction()` Returns the value of the 'Related Save Action' reference.
    `ActionDescriptor` | Property.`getRetrieveAllValues()` Returns the value of the 'Retrieve All Values' reference.
    `ActionDescriptor` | ApplicationOptions.`getRootContainersAction()` Returns the value of the 'Root Containers Action' reference.
    `ActionDescriptor` | RToolValidateAction.`getTargetID()` Returns the value of the 'Target ID' reference.
    `ActionDescriptor` | RFilterAction.`getTargetID()` Returns the value of the 'Target ID' reference.
    `ActionDescriptor` | RFileAction.`getTargetID()` Returns the value of the 'Target ID' reference.
    `ActionDescriptor` | RErrorViewAction.`getTargetID()` Returns the value of the 'Target ID' reference.
    `ActionDescriptor` | RElementlistAction.`getTargetID()` Returns the value of the 'Target ID' reference.
    `ActionDescriptor` | RElementActionBase.`getTargetID()` Returns the value of the 'Target ID' reference.
    `ActionDescriptor` | RApplicationAction.`getTargetID()` Returns the value of the 'Target ID' reference.
    `ActionDescriptor` | GlobalAction.`getTargetID()` Returns the value of the 'Target ID' reference.

    Methods in com.microfocus.awm.meta.interfaces that return types with arguments of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `org.eclipse.emf.common.util.EList<ActionDescriptor>` | CActionDescriptors.`getActionDescriptor()` Returns the value of the 'Action Descriptor' containment reference list.
    `org.eclipse.emf.common.util.EList<ActionDescriptor>` | ISAISPFPanel.`getHasAction()` Returns the value of the 'Has Action' containment reference list.

    Methods in com.microfocus.awm.meta.interfaces with parameters of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `void` | ToolDescriptor.`setAfterJobAction(ActionDescriptor value)` Sets the value of the '`After Job Action`' reference.
    `void` | ElementType.`setGetAllProperties(ActionDescriptor value)` Deprecated. use `ElementType.setHasGetPropertiesAction(RElementGetProperties)` instead
    `void` | ActionDescriptor.`setRelatedCloseAction(ActionDescriptor value)` Sets the value of the '`Related Close Action`' reference.
    `void` | ActionDescriptor.`setRelatedSaveAction(ActionDescriptor value)` Sets the value of the '`Related Save Action`' reference.
    `void` | Property.`setRetrieveAllValues(ActionDescriptor value)` Sets the value of the '`Retrieve All Values`' reference.
    `void` | ApplicationOptions.`setRootContainersAction(ActionDescriptor value)` Sets the value of the '`Root Containers Action`' reference.
    `void` | RToolValidateAction.`setTargetID(ActionDescriptor value)` Sets the value of the '`Target ID`' reference.
    `void` | RFilterAction.`setTargetID(ActionDescriptor value)` Sets the value of the '`Target ID`' reference.
    `void` | RFileAction.`setTargetID(ActionDescriptor value)` Sets the value of the '`Target ID`' reference.
    `void` | RErrorViewAction.`setTargetID(ActionDescriptor value)` Sets the value of the '`Target ID`' reference.
    `void` | RElementlistAction.`setTargetID(ActionDescriptor value)` Sets the value of the '`Target ID`' reference.
    `void` | RElementActionBase.`setTargetID(ActionDescriptor value)` Sets the value of the '`Target ID`' reference.
    `void` | RApplicationAction.`setTargetID(ActionDescriptor value)` Sets the value of the '`Target ID`' reference.
    `void` | GlobalAction.`setTargetID(ActionDescriptor value)` Sets the value of the '`Target ID`' reference.

  - ### Uses of ActionDescriptor in com.microfocus.awm.meta.interfaces.validation

    Methods in com.microfocus.awm.meta.interfaces.validation with parameters of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | ToolDescriptorValidator.`validateAfterJobAction(ActionDescriptor value)`
    `boolean` | ElementTypeValidator.`validateGetAllProperties(ActionDescriptor value)`
    `boolean` | ElementTypeValidator.`validateGetChildren(ActionDescriptor value)`
    `boolean` | ActionDescriptorValidator.`validateRelatedCloseAction(ActionDescriptor value)`
    `boolean` | ActionDescriptorValidator.`validateRelatedSaveAction(ActionDescriptor value)`
    `boolean` | PropertyValidator.`validateRetrieveAllValues(ActionDescriptor value)`
    `boolean` | ApplicationOptionsValidator.`validateRootContainersAction(ActionDescriptor value)`
    `boolean` | RToolValidateActionValidator.`validateTargetID(ActionDescriptor value)`
    `boolean` | RFilterActionValidator.`validateTargetID(ActionDescriptor value)`
    `boolean` | RFileActionValidator.`validateTargetID(ActionDescriptor value)`
    `boolean` | RErrorViewActionValidator.`validateTargetID(ActionDescriptor value)`
    `boolean` | RElementlistActionValidator.`validateTargetID(ActionDescriptor value)`
    `boolean` | RElementActionValidator.`validateTargetID(ActionDescriptor value)`
    `boolean` | RElementActionBaseValidator.`validateTargetID(ActionDescriptor value)`
    `boolean` | RApplicationActionValidator.`validateTargetID(ActionDescriptor value)`
    `boolean` | GlobalActionValidator.`validateTargetID(ActionDescriptor value)`

    Method parameters in com.microfocus.awm.meta.interfaces.validation with type arguments of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | CActionDescriptorsValidator.`validateActionDescriptor(org.eclipse.emf.common.util.EList<ActionDescriptor> value)`
    `boolean` | ISAISPFPanelValidator.`validateHasAction(org.eclipse.emf.common.util.EList<ActionDescriptor> value)`

  - ### Uses of ActionDescriptor in com.microfocus.awm.meta.util

    Methods in com.microfocus.awm.meta.util with parameters of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `T` | TaurusSwitch.`caseActionDescriptor(ActionDescriptor object)` Returns the result of interpreting the object as an instance of 'Action Descriptor'.
    `boolean` | TaurusValidator.`validateActionDescriptor_CrossReferenceValidation(ActionDescriptor actionDescriptor, org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)` Validates the CrossReferenceValidation constraint of ' Action Descriptor'.
    `boolean` | TaurusValidator.`validateActionDescriptor_MultipleToolSeqNo(ActionDescriptor actionDescriptor, org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)` Validates the MultipleToolSeqNo constraint of 'Action Descriptor '.
    `boolean` | TaurusValidator.`validateActionDescriptor(ActionDescriptor actionDescriptor, org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)`

  - ### Uses of ActionDescriptor in com.microfocus.awm.model

    Methods in com.microfocus.awm.model that return ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `ActionDescriptor` | IElementList.`getAction()` Gets the action descriptor which created this element list.
    `ActionDescriptor` | IExecutionContext.`getActionDescriptor()` Gets the `ActionDescriptor` of the context.
    `ActionDescriptor` | IAction.`getActionDescriptor()` Gets the action descriptor of this action.

    Methods in com.microfocus.awm.model with parameters of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `void` | IElementListDirectory.`addResourceActionList(ActionDescriptor pAction, IResource pResource, java.lang.String pElementListID)` Deprecated.
    `IAction` | IVisibleActionExecutor.`executeAction(ISystemImage pImg, IExecutionContext pContext, ActionDescriptor pTauAction)` For actions which are not executed on `IResource`s.
    `IAction` | IVisibleActionExecutor.`executeAction(ISystemImage pImg, IResource pRes, ActionDescriptor pTauAction)` Executes an action.
    `IElementList` | IElementListDirectory.`restoreList(ActionDescriptor pAct, IResource pRes)` Tries to restore a Element List for the given parameters.

  - ### Uses of ActionDescriptor in com.microfocus.awm.model.internal

    Methods in com.microfocus.awm.model.internal that return ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `ActionDescriptor` | ElementList.`getAction()`
    `ActionDescriptor` | ExecutionContext.`getActionDescriptor()`
    `ActionDescriptor` | Action.`getActionDescriptor()`

    Methods in com.microfocus.awm.model.internal with parameters of type ActionDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `void` | ElementListDirectory.`addResourceActionList(ActionDescriptor pActionDescriptor, IResource pIResource, java.lang.String pElementListID)` Deprecated.
    `static IElementList` | ElementList.`emptyElementList(ActionDescriptor pAct)` Convenience method to create a new list with no parent, a generated default ID an a default `ElementListStructure` without any columns
    `IElementList` | ElementListDirectory.`restoreList(ActionDescriptor pAct, IResource pRes)`

    Constructors in com.microfocus.awm.model.internal with parameters of type ActionDescriptor
    Constructor and Description
    `Action(ActionDescriptor pActionDesc, IExecutionContext pContext)` Basic constructor.
    `ElementList(ElementListStructure pElementListStructure, ActionDescriptor pAction)` Creates a new list with no parent and a default generated ID.
    `ElementList(ElementListStructure pElementListStructure, ActionDescriptor pAction, IResource pParent)` Creates a new list with a default generated ID.
    `ElementList(ElementListStructure pElemetListStructure, ActionDescriptor pAction, java.lang.String pElementListID)` Creates a new list with no parent.
    `ElementList(ElementListStructure pElemetListStructure, ActionDescriptor pAction, java.lang.String pElementListID, IResource pParent)` creates a new list.
    `ElementListKey(ActionDescriptor pActionID, IResource pResource)` Basic constructor.
    `ExecutionContext(ISystemImage pSys, ActionDescriptor pActionDescriptor)` Basic constructor.

Copyright © 2015 Micro Focus GmbH. All rights reserved.