com.microfocus.awm.model

Interface IAction

All Known Implementing Classes:

Action

public interface IAction

Result of executing an ActionDescriptor.

Not intended to be sub-classed.

Author:

Micro Focus

See Also:

ActionExecutor

Method Summary

Modifier and Type	Method and Description
void	addElementListEntryToSelect(IElementListEntry pEntry) Adds an IElementListEntry to be selected after the execution of the action.
ActionDescriptor	getActionDescriptor() Gets the action descriptor of this action.
IElementList	getElementList() Returns an element list if the performed action created one.
java.util.List<IElementListEntry>	getElementListEntriesToSelect()
java.lang.Exception	getException() Returns an exception (if one occurred during the execution of this ActionDescriptor) or null, if no exception occurred.
IExecutionContext	getExecutionContext() Gets the execution context of this action.
java.util.List<IToolResult>	getResourceProcessingProblemResults() Gets a list of tool results which caused problems during resource processing.
java.util.List<IToolResult>	getToolResults() Gets the tool results of all tools executed by this action.
boolean	isCanceled() Returns true if the action was cancelled by the user (even if an input dialog was cancelled).
void	setCanceled(boolean pCanceled) Whether the action was cancelled by the user.
void	setElementList(IElementList pEleList) Sets the element list of this action.
void	setException(java.lang.Exception pE) Sets the exception of this action.

Method Detail

getActionDescriptor

ActionDescriptor getActionDescriptor()

Gets the action descriptor of this action.

Returns:

the action descriptor

getExecutionContext

IExecutionContext getExecutionContext()

Gets the execution context of this action.

Returns:

the IExecutionContext

getElementList

IElementList getElementList()

Returns an element list if the performed action created one.

Returns:

an IElementList or null

setElementList

void setElementList(IElementList pEleList)

Sets the element list of this action. This is usually done after an element list was created by an action.

Parameters:

pEleList - the element list which was created by this action

See Also:

getElementList()

getException

java.lang.Exception getException()

Returns an exception (if one occurred during the execution of this ActionDescriptor) or null, if no exception occurred.

Returns:

the exception or null

setException

void setException(java.lang.Exception pE)

Sets the exception of this action.

Parameters:

pE - the exception

See Also:

getException()

setCanceled

void setCanceled(boolean pCanceled)

Whether the action was cancelled by the user.

Parameters:

pCanceled - true if the action was cancelled by the user. false otherwise.

isCanceled

boolean isCanceled()

Returns true if the action was cancelled by the user (even if an input dialog was cancelled).

Returns:

whether the action was cancelled

getElementListEntriesToSelect

java.util.List<IElementListEntry> getElementListEntriesToSelect()

Returns:

a list of IElementListEntry that should be selected after the execution of this action. The list can only contain entries, if TOOL-DEFINED resource operations with SELECT parameters were executed.

See Also:

addElementListEntryToSelect(IElementListEntry)

addElementListEntryToSelect

void addElementListEntryToSelect(IElementListEntry pEntry)

Adds an IElementListEntry to be selected after the execution of the action.

Parameters:

pEntry - the IElementListEntry

See Also:

getElementListEntriesToSelect()

getToolResults

java.util.List<IToolResult> getToolResults()

Gets the tool results of all tools executed by this action.

Returns:

the IToolResults of all tools executed by this action.

getResourceProcessingProblemResults

java.util.List<IToolResult> getResourceProcessingProblemResults()

Gets a list of tool results which caused problems during resource processing.

Returns:

IToolResult which contained resource operations that caused problems while being processed