com.microfocus.awm.internal.functionpackage.awm.tools

Class ReturnPropertyValue2

java.lang.Object

com.microfocus.awm.internal.functionpackage.awm.tools.ReturnPropertyValue2

All Implemented Interfaces:

IToolExecutor2

public class ReturnPropertyValue2
extends java.lang.Object
implements IToolExecutor2

A tool executor that is used to return output parameters with the property value of the corresponding input parameters.

Copyright Micro Focus GmbH.

Author:

NicolasP

Constructor Summary

Constructors

Constructor and Description
ReturnPropertyValue2()

Method Summary

Modifier and Type	Method and Description
IToolContext	createToolContext(IExecutionContext pExecutionContext, ToolDescriptor pToolDescriptor, boolean pIsMassProcessing) This method creates a IToolContext.
IToolResult	executeMassProcessing(IMassProcessingToolContext pMassProcessingContext, org.eclipse.core.runtime.IProgressMonitor pMon) Executes the tool for multiple resource.
IToolResult	executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon) Executes the tool for a single resource.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microfocus.awm.model.toolexecution.IToolExecutor2

init, supportsMassProcessing

Constructor Detail

ReturnPropertyValue2

public ReturnPropertyValue2()

Method Detail

createToolContext

public IToolContext createToolContext(IExecutionContext pExecutionContext,
                                      ToolDescriptor pToolDescriptor,
                                      boolean pIsMassProcessing)
                               throws TaurusToolException

Description copied from interface: IToolExecutor2

This method creates a IToolContext. By default an AWM internal IMassProcessingToolContext or single processing IToolContext is created.

This method must return an IMassProcessingToolContext, if the isMassProcessing parameter is set to true. The support of mass processing can be disabled by returning false in the method IToolExecutor2.supportsMassProcessing().

Specified by:

createToolContext in interface IToolExecutor2

Parameters:

pExecutionContext - the IExecutionContext which is used for the execution of the ToolDescriptor

pToolDescriptor - the corresponding ToolDescriptor

pIsMassProcessing - whether this IToolExecutor2 should be executed as mass processing or not. If this parameter is set to true, this method has to return a IMassProcessingToolContext.

Returns:

the IToolContext which will be used for the execution of the IToolExecutor2.

Throws:

TaurusToolException - if an exception occurs while creating an IToolContext.

executeSingleProcessing

public IToolResult executeSingleProcessing(IToolContext pToolContext,
                                           org.eclipse.core.runtime.IProgressMonitor pMon)
                                    throws TaurusToolException

Description copied from interface: IToolExecutor2

Executes the tool for a single resource.

A tool typically obtains values of modeled attributes and input parameters through the IToolContext (or ToolUtility helper methods), runs its specific function and returns all results (including possible output parameters) in the IToolResult.

This method gets called if the tool is being executed from an ActionDescriptor with the Mass Processing attribute set to false or if IToolExecutor2.supportsMassProcessing() returned false.

The tool context contains all parameters, since their Mass Processing flags are ignored during single processing execution.

Specified by:

executeSingleProcessing in interface IToolExecutor2

Parameters:

pToolContext - the tool context

pMon - a progress monitor. Setting the monitor to canceled will cancel the action after the tool has been executed

Returns:

an IToolResult

Throws:

TaurusToolException - if the tool cannot be executed for any reason

See Also:

ToolUtility

executeMassProcessing

public IToolResult executeMassProcessing(IMassProcessingToolContext pMassProcessingContext,
                                         org.eclipse.core.runtime.IProgressMonitor pMon)
                                  throws TaurusToolException

Description copied from interface: IToolExecutor2

Executes the tool for multiple resource. In contrast to IToolExecutor2.executeSingleProcessing(IToolContext, IProgressMonitor) the tool executor can process multiple resources with a single call.

If the tool executor does not support mass processing execution (by returning false with IToolExecutor2.supportsMassProcessing()), this method will never by called by AWM and can simply return null.

The list of resources to be processed by the mass processing action can be obtained from the mass processing tool context via IMassProcessingToolContext.getSubContexts().

The IMassProcessingToolContext only contains parameters with the Mass Processing flag set to false. Mass processing parameters are contained by its sub-contexts.

Specified by:

executeMassProcessing in interface IToolExecutor2

Parameters:

pMassProcessingContext - the mass processing context

pMon - a progress monitor. Setting the monitor to canceled will cancel the action after the tool has been executed

Returns:

an IToolResult. Can be null if IToolExecutor2.supportsMassProcessing() returned false

Throws:

TaurusToolException - if the tool cannot be executed for any reason

See Also:

ToolUtility