org.pm4j.core.pm.annotation
Annotation Type PmCommandCfg


@Retention(value=RUNTIME)
@Target(value={TYPE,FIELD})
public @interface PmCommandCfg

Static configuration data for commands.

Author:
olaf boede

Optional Element Summary
 PmCommandCfg.BEFORE_DO beforeDo
           
 PmCacheApi.CacheKind[] clearCaches
          Defines the caches to clear within the element context of this command.
 PmCommand.CmdKind cmdKind
           
 boolean hideWhenNotEnabled
           
 boolean requiresValidValues
          Deprecated. Please use beforeDo().
 

requiresValidValues

@Deprecated
public abstract boolean requiresValidValues
Deprecated. Please use beforeDo().

Returns:
true when the command should fail when there are invalid values within the current session.
Default:
false

beforeDo

public abstract PmCommandCfg.BEFORE_DO beforeDo
Returns:
Defines what should be done before executing the command logic.
See Also:
PmCommandCfg.BEFORE_DO
Default:
org.pm4j.core.pm.annotation.PmCommandCfg.BEFORE_DO.DEFAULT

cmdKind

public abstract PmCommand.CmdKind cmdKind
Returns:
The PmCommand.CmdKind of this command class.
Default:
org.pm4j.core.pm.PmCommand.CmdKind.COMMAND

hideWhenNotEnabled

public abstract boolean hideWhenNotEnabled
Returns:
true when the command should be hidden when not applicable.
Default:
false

clearCaches

public abstract PmCacheApi.CacheKind[] clearCaches
Defines the caches to clear within the element context of this command.

Returns:
The cache kinds to clear.
Default:
{}