IAction (TSL2 Framework Commons 2.2.0 API)

All Superinterfaces:

Runnable

All Known Implementing Classes:

CommonAction
```
public interface IAction<RETURNTYPE>
extends Runnable
```
provides all informations to start an action (through Runnable) and to handle a graphical user interface of type button etc.

Version:

$Revision: 1.0 $

Author:

ts 13.11.2008

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CANCELED`
`static int`	`MODE_DLG_CANCEL` dialog return value: dialog will be closed, and IDialogConstants.CANCEL_ID will be returned
`static int`	`MODE_DLG_OK` dialog return value: dialog will be closed, and IDialogConstants.OK_ID will be returned
`static int`	`MODE_UNDEFINED` dialog return value - no dialog handling will be done

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`RETURNTYPE`	`action()` The action to be started
`RETURNTYPE`	`activate()` starts this action.
`static int`	`doFor(Collection<?> forCollection, IAction<?> doAction)` starts the given action for all items of the given collection - as first action parameter.
`int`	`getActionMode()` action mode. e.g. on dialogs it is usable to define the buttons result type. see `MODE_DLG_CANCEL`, `MODE_DLG_OK`.
`Class[]`	`getArgumentTypes()` getArgumentTypes
`String`	`getId()` Getter getId
`String`	`getImagePath()`
`Object`	`getKeyStroke()` Getter getKeyStroke
`String`	`getLongDescription()` Getter getLongDescription
`Object[]`	`getParameter()`
`Object`	`getParameter(int i)`
`Collection<String>`	`getReceiverIDs()` the receivers will receive the result of the activation.
`String`	`getShortDescription()` Getter getShortDescription
`boolean`	`isDefault()` Getter isDefault
`boolean`	`isEnabled()` Getter isEnabled
`boolean`	`isRunning()`
`boolean`	`isSynchron()` Getter isSynchron
`void`	`setDefault(boolean isDefault)` setDefault
`void`	`setEnabled(boolean isEnabled)` Setter isEnabled
`void`	`setParameter(Object... parameter)`

Methods inherited from interface java.lang.Runnable
run

- Field Detail
  - CANCELED
```
static final String CANCELED
```
    See Also:
    
    Constant Field Values
  - MODE_UNDEFINED
```
static final int MODE_UNDEFINED
```
    dialog return value - no dialog handling will be done
    
    See Also:
    
    Constant Field Values
  - MODE_DLG_CANCEL
```
static final int MODE_DLG_CANCEL
```
    dialog return value: dialog will be closed, and IDialogConstants.CANCEL_ID will be returned
    
    See Also:
    
    Constant Field Values
  - MODE_DLG_OK
```
static final int MODE_DLG_OK
```
    dialog return value: dialog will be closed, and IDialogConstants.OK_ID will be returned
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isEnabled
```
boolean isEnabled()
```
    Getter isEnabled
    
    Returns:
    
    Returns the isEnabled.
  - setEnabled
```
void setEnabled(boolean isEnabled)
```
    Setter isEnabled
    
    Parameters:
    
    isEnabled - The isEnabled to set.
  - getKeyStroke
```
Object getKeyStroke()
```
    Getter getKeyStroke
    
    Returns:
    
    Returns the keyStroke.
  - getId
```
String getId()
```
    Getter getId
    
    Returns:
    
    Returns the id.
  - getShortDescription
```
String getShortDescription()
```
    Getter getShortDescription
    
    Returns:
    
    Returns the shortDescription.
  - getLongDescription
```
String getLongDescription()
```
    Getter getLongDescription
    
    Returns:
    
    Returns the longDescription.
  - getImagePath
```
String getImagePath()
```
    Returns:
    
    image
  - isDefault
```
boolean isDefault()
```
    Getter isDefault
    
    Returns:
    
    Returns the isDefault.
  - setDefault
```
void setDefault(boolean isDefault)
```
    setDefault
    
    Parameters:
    
    isDefault - whether to set the action as default action
  - isSynchron
```
boolean isSynchron()
```
    Getter isSynchron
    
    Returns:
    
    Returns the synchron.
  - action
```
RETURNTYPE action()
           throws Exception
```
    The action to be started
    
    Returns:
    
    result of the action. use CANCELED to define for buttons, the action was canceled.
    
    Throws:
    
    Exception
  - activate
```
RETURNTYPE activate()
```
    starts this action.
    
    Returns:
    
    the result
  - getReceiverIDs
```
Collection<String> getReceiverIDs()
```
    the receivers will receive the result of the activation.
    
    Returns:
    
    list of ids of receiver fields (IComponentDescriptor)
  - getArgumentTypes
```
Class[] getArgumentTypes()
```
    getArgumentTypes
    
    Returns:
    
    optional definition of argument types to check getParameter() and setParameter(Object...). default is null
  - getParameter
```
Object[] getParameter()
```
    Returns:
    
    optional call arguments for action.
  - getParameter
```
Object getParameter(int i)
```
  - setParameter
```
void setParameter(Object... parameter)
```
    Parameters:
    
    parameter - call arguments
  - getActionMode
```
int getActionMode()
```
    action mode. e.g. on dialogs it is usable to define the buttons result type. see MODE_DLG_CANCEL, MODE_DLG_OK.
    
    Returns:
    
    action mode
  - isRunning
```
boolean isRunning()
```
  - doFor
```
static int doFor(Collection<?> forCollection,
                 IAction<?> doAction)
```
    starts the given action for all items of the given collection - as first action parameter.
    
    Parameters:
    
    forCollection - to iterate
    
    doAction - to do
    
    Returns:
    
    iteration size

Interface IAction<RETURNTYPE>

Field Summary

Method Summary

Methods inherited from interface java.lang.Runnable

Field Detail

CANCELED

MODE_UNDEFINED

MODE_DLG_CANCEL

MODE_DLG_OK

Method Detail

isEnabled

setEnabled

getKeyStroke

getId

getShortDescription

getLongDescription

getImagePath

isDefault

setDefault

isSynchron

action

activate

getReceiverIDs

getArgumentTypes

getParameter

getParameter

setParameter

getActionMode

isRunning

doFor