Command

All Superinterfaces:

com.softwareag.cis.plugin.interfaces.Component

All Known Implementing Classes:

AbstractCommand, CompileLayoutsCommand, InstallPlugInCommand, StartApplicationDesignerCommand, UninstallPlugInCommand
```
public interface Command
extends com.softwareag.cis.plugin.interfaces.Component
```
An interface describing a command which may be rendered in a menu or toolbar

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CATEGORY_APPLICATION_HIGH_PRIO`
`static int`	`CATEGORY_APPLICATION_LOW_PRIO`
`static int`	`CATEGORY_COPY`
`static int`	`CATEGORY_DELETE`
`static int`	`CATEGORY_DOCUMENT`
`static int`	`CATEGORY_EDIT`
`static int`	`CATEGORY_EXECUTE`
`static int`	`CATEGORY_FAVORITES`
`static int`	`CATEGORY_IMPORT_EXPORT`
`static int`	`CATEGORY_LCM`
`static int`	`CATEGORY_LINK`
`static int`	`CATEGORY_MIN`
`static int`	`CATEGORY_MISC`
`static int`	`CATEGORY_NEW`
`static int`	`CATEGORY_OBJECT`
`static int`	`CATEGORY_OPEN`
`static int`	`CATEGORY_PREFERENCES`
`static int`	`CATEGORY_SAVE`
`static int`	`CATEGORY_SEARCH`
`static int`	`CATEGORY_SHOW`
`static int`	`CATEGORY_UPDATE`
`static int`	`CATEGORY_UPDATE_EXT`
`static int`	`CATEGORY_VIEW`
`static int`	`COMMAND_ACTIVATE_DEACTIVATE`
`static int`	`COMMAND_ADD_CATEGORY`
`static int`	`COMMAND_ADD_COPY`
`static int`	`COMMAND_ADD_DOCUMENT`
`static int`	`COMMAND_ADD_FOLDER`
`static int`	`COMMAND_ADD_TO_FAVORITES`
`static int`	`COMMAND_ADD_TO_LIST`
`static int`	`COMMAND_ADD_TYPE`
`static int`	`COMMAND_ADD_VERSION`
`static int`	`COMMAND_ATTACH_WS_POLICY`
`static int`	`COMMAND_ATTACH_WSDL`
`static int`	`COMMAND_CHANGE_LIFEC_STATE`
`static int`	`COMMAND_CHANGE_PROVIDING_ORG`
`static int`	`COMMAND_CHECK_CONN`
`static int`	`COMMAND_COMPARE`
`static int`	`COMMAND_COPY_SHORTCUT`
`static int`	`COMMAND_DELETE`
`static int`	`COMMAND_DOCUMENTATION`
`static int`	`COMMAND_DOWNLOAD`
`static int`	`COMMAND_DOWNLOAD_BPEL`
`static int`	`COMMAND_DOWNLOAD_WSDL`
`static int`	`COMMAND_DOWNLOAD_XMLSCHEMA`
`static int`	`COMMAND_EDIT_DETAILS`
`static int`	`COMMAND_EXPORT`
`static int`	`COMMAND_EXPORT_CONTENTS`
`static int`	`COMMAND_EXPORT_FAVORITE`
`static int`	`COMMAND_GENERATE_REPORT`
`static int`	`COMMAND_IMPACT_ANALYSIS`
`static int`	`COMMAND_IMPORT_ASSET`
`static int`	`COMMAND_LC_CREATE_NEW_VERS`
`static int`	`COMMAND_NOTIFY_ME`
`static int`	`COMMAND_PERMISSIONS`
`static int`	`COMMAND_REGISTER_AS_CONSUMER`
`static int`	`COMMAND_REGISTER_CONS`
`static int`	`COMMAND_REMOVE_FROM_FAVORITES`
`static int`	`COMMAND_RENAME`
`static int`	`COMMAND_RENAME_LIST`
`static int`	`COMMAND_SHOW_DETAILS`
`static int`	`COMMAND_VIRTUALIZE`
`static java.lang.String`	`rcs_id`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`execute(CommandContext commandContext)` Execute command for given CommandContext
`void`	`executeWrapped(CommandContext commandContext)` Execute command for given ActionContext.
`int`	`getCategory()` The value returned by this command may be used for command ordering and grouping (for example in a context menu)
`java.lang.String`	`getImageURL()` Get URL of icon to be used for rendering of command.
`java.util.Locale`	`getLocale()` Obtain Locale for this command
`java.lang.String`	`getName()` Get localized name of command - may be used e.g.
`java.util.List`	`getSubCommands()`
`boolean`	`isEnabled(CommandContext context)` Is this command enabled?
`boolean`	`isSameGroup(Command other)` Check whether this command belongs to same group as other
`boolean`	`isToBeVisualized(CommandContext context)` Test whether this command is to be visualized in the current context
`void`	`setLocale(java.util.Locale lc)` Set Locale for this command

Methods inherited from interface com.softwareag.cis.plugin.interfaces.Component
getId, isEnabled, isVisible, setEnabled, setVisible

- Field Detail
  - rcs_id
```
static final java.lang.String rcs_id
```
    See Also:
    
    Constant Field Values
  - CATEGORY_MIN
```
static final int CATEGORY_MIN
```
    See Also:
    
    Constant Field Values
  - CATEGORY_OPEN
```
static final int CATEGORY_OPEN
```
    See Also:
    
    Constant Field Values
  - CATEGORY_EDIT
```
static final int CATEGORY_EDIT
```
    See Also:
    
    Constant Field Values
  - CATEGORY_SAVE
```
static final int CATEGORY_SAVE
```
    See Also:
    
    Constant Field Values
  - CATEGORY_NEW
```
static final int CATEGORY_NEW
```
    See Also:
    
    Constant Field Values
  - CATEGORY_DELETE
```
static final int CATEGORY_DELETE
```
    See Also:
    
    Constant Field Values
  - CATEGORY_UPDATE
```
static final int CATEGORY_UPDATE
```
    See Also:
    
    Constant Field Values
  - CATEGORY_UPDATE_EXT
```
static final int CATEGORY_UPDATE_EXT
```
    See Also:
    
    Constant Field Values
  - CATEGORY_COPY
```
static final int CATEGORY_COPY
```
    See Also:
    
    Constant Field Values
  - CATEGORY_LCM
```
static final int CATEGORY_LCM
```
    See Also:
    
    Constant Field Values
  - CATEGORY_OBJECT
```
static final int CATEGORY_OBJECT
```
    See Also:
    
    Constant Field Values
  - CATEGORY_DOCUMENT
```
static final int CATEGORY_DOCUMENT
```
    See Also:
    
    Constant Field Values
  - CATEGORY_FAVORITES
```
static final int CATEGORY_FAVORITES
```
    See Also:
    
    Constant Field Values
  - CATEGORY_IMPORT_EXPORT
```
static final int CATEGORY_IMPORT_EXPORT
```
    See Also:
    
    Constant Field Values
  - CATEGORY_APPLICATION_HIGH_PRIO
```
static final int CATEGORY_APPLICATION_HIGH_PRIO
```
    See Also:
    
    Constant Field Values
  - CATEGORY_EXECUTE
```
static final int CATEGORY_EXECUTE
```
    See Also:
    
    Constant Field Values
  - CATEGORY_LINK
```
static final int CATEGORY_LINK
```
    See Also:
    
    Constant Field Values
  - CATEGORY_PREFERENCES
```
static final int CATEGORY_PREFERENCES
```
    See Also:
    
    Constant Field Values
  - CATEGORY_SHOW
```
static final int CATEGORY_SHOW
```
    See Also:
    
    Constant Field Values
  - CATEGORY_VIEW
```
static final int CATEGORY_VIEW
```
    See Also:
    
    Constant Field Values
  - CATEGORY_SEARCH
```
static final int CATEGORY_SEARCH
```
    See Also:
    
    Constant Field Values
  - CATEGORY_APPLICATION_LOW_PRIO
```
static final int CATEGORY_APPLICATION_LOW_PRIO
```
    See Also:
    
    Constant Field Values
  - CATEGORY_MISC
```
static final int CATEGORY_MISC
```
    See Also:
    
    Constant Field Values
  - COMMAND_SHOW_DETAILS
```
static final int COMMAND_SHOW_DETAILS
```
    See Also:
    
    Constant Field Values
  - COMMAND_EDIT_DETAILS
```
static final int COMMAND_EDIT_DETAILS
```
    See Also:
    
    Constant Field Values
  - COMMAND_RENAME
```
static final int COMMAND_RENAME
```
    See Also:
    
    Constant Field Values
  - COMMAND_PERMISSIONS
```
static final int COMMAND_PERMISSIONS
```
    See Also:
    
    Constant Field Values
  - COMMAND_DELETE
```
static final int COMMAND_DELETE
```
    See Also:
    
    Constant Field Values
  - COMMAND_CHANGE_LIFEC_STATE
```
static final int COMMAND_CHANGE_LIFEC_STATE
```
    See Also:
    
    Constant Field Values
  - COMMAND_LC_CREATE_NEW_VERS
```
static final int COMMAND_LC_CREATE_NEW_VERS
```
    See Also:
    
    Constant Field Values
  - COMMAND_ADD_TYPE
```
static final int COMMAND_ADD_TYPE
```
    See Also:
    
    Constant Field Values
  - COMMAND_ADD_CATEGORY
```
static final int COMMAND_ADD_CATEGORY
```
    See Also:
    
    Constant Field Values
  - COMMAND_REGISTER_CONS
```
static final int COMMAND_REGISTER_CONS
```
    See Also:
    
    Constant Field Values
  - COMMAND_IMPORT_ASSET
```
static final int COMMAND_IMPORT_ASSET
```
    See Also:
    
    Constant Field Values
  - COMMAND_EXPORT
```
static final int COMMAND_EXPORT
```
    See Also:
    
    Constant Field Values
  - COMMAND_IMPACT_ANALYSIS
```
static final int COMMAND_IMPACT_ANALYSIS
```
    See Also:
    
    Constant Field Values
  - COMMAND_GENERATE_REPORT
```
static final int COMMAND_GENERATE_REPORT
```
    See Also:
    
    Constant Field Values
  - COMMAND_ATTACH_WSDL
```
static final int COMMAND_ATTACH_WSDL
```
    See Also:
    
    Constant Field Values
  - COMMAND_COMPARE
```
static final int COMMAND_COMPARE
```
    See Also:
    
    Constant Field Values
  - COMMAND_ADD_VERSION
```
static final int COMMAND_ADD_VERSION
```
    See Also:
    
    Constant Field Values
  - COMMAND_ADD_COPY
```
static final int COMMAND_ADD_COPY
```
    See Also:
    
    Constant Field Values
  - COMMAND_CHECK_CONN
```
static final int COMMAND_CHECK_CONN
```
    See Also:
    
    Constant Field Values
  - COMMAND_ACTIVATE_DEACTIVATE
```
static final int COMMAND_ACTIVATE_DEACTIVATE
```
    See Also:
    
    Constant Field Values
  - COMMAND_NOTIFY_ME
```
static final int COMMAND_NOTIFY_ME
```
    See Also:
    
    Constant Field Values
  - COMMAND_EXPORT_CONTENTS
```
static final int COMMAND_EXPORT_CONTENTS
```
    See Also:
    
    Constant Field Values
  - COMMAND_COPY_SHORTCUT
```
static final int COMMAND_COPY_SHORTCUT
```
    See Also:
    
    Constant Field Values
  - COMMAND_ADD_TO_LIST
```
static final int COMMAND_ADD_TO_LIST
```
    See Also:
    
    Constant Field Values
  - COMMAND_DOWNLOAD
```
static final int COMMAND_DOWNLOAD
```
    See Also:
    
    Constant Field Values
  - COMMAND_DOCUMENTATION
```
static final int COMMAND_DOCUMENTATION
```
    See Also:
    
    Constant Field Values
  - COMMAND_ADD_FOLDER
```
static final int COMMAND_ADD_FOLDER
```
    See Also:
    
    Constant Field Values
  - COMMAND_ADD_DOCUMENT
```
static final int COMMAND_ADD_DOCUMENT
```
    See Also:
    
    Constant Field Values
  - COMMAND_ADD_TO_FAVORITES
```
static final int COMMAND_ADD_TO_FAVORITES
```
    See Also:
    
    Constant Field Values
  - COMMAND_REMOVE_FROM_FAVORITES
```
static final int COMMAND_REMOVE_FROM_FAVORITES
```
    See Also:
    
    Constant Field Values
  - COMMAND_RENAME_LIST
```
static final int COMMAND_RENAME_LIST
```
    See Also:
    
    Constant Field Values
  - COMMAND_EXPORT_FAVORITE
```
static final int COMMAND_EXPORT_FAVORITE
```
    See Also:
    
    Constant Field Values
  - COMMAND_VIRTUALIZE
```
static final int COMMAND_VIRTUALIZE
```
    See Also:
    
    Constant Field Values
  - COMMAND_REGISTER_AS_CONSUMER
```
static final int COMMAND_REGISTER_AS_CONSUMER
```
    See Also:
    
    Constant Field Values
  - COMMAND_ATTACH_WS_POLICY
```
static final int COMMAND_ATTACH_WS_POLICY
```
    See Also:
    
    Constant Field Values
  - COMMAND_CHANGE_PROVIDING_ORG
```
static final int COMMAND_CHANGE_PROVIDING_ORG
```
    See Also:
    
    Constant Field Values
  - COMMAND_DOWNLOAD_WSDL
```
static final int COMMAND_DOWNLOAD_WSDL
```
    See Also:
    
    Constant Field Values
  - COMMAND_DOWNLOAD_BPEL
```
static final int COMMAND_DOWNLOAD_BPEL
```
    See Also:
    
    Constant Field Values
  - COMMAND_DOWNLOAD_XMLSCHEMA
```
static final int COMMAND_DOWNLOAD_XMLSCHEMA
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
java.lang.String getName()
```
    Get localized name of command - may be used e.g. for label in context menu or tooltip in toolbar
    
    Returns:
    
    the name
  - getImageURL
```
java.lang.String getImageURL()
```
    Get URL of icon to be used for rendering of command. May be null if no icon available or required.
    
    Returns:
    
    the URL
  - getCategory
```
int getCategory()
```
    The value returned by this command may be used for command ordering and grouping (for example in a context menu)
    
    Returns:
    
    one of the CATEGORY_* values
  - isSameGroup
```
boolean isSameGroup(Command other)
```
    Check whether this command belongs to same group as other
    
    Parameters:
    
    other -
    
    Returns:
    
    true if same group; false otherwise
  - getSubCommands
```
java.util.List getSubCommands()
```
  - setLocale
```
void setLocale(java.util.Locale lc)
```
    Set Locale for this command
    
    Parameters:
    
    lc -
  - getLocale
```
java.util.Locale getLocale()
```
    Obtain Locale for this command
    
    Returns:
    
    the Locale used for this command
  - isEnabled
```
boolean isEnabled(CommandContext context)
```
    Is this command enabled?
    
    Parameters:
    
    context -
    
    Returns:
    
    true if enabled
  - isToBeVisualized
```
boolean isToBeVisualized(CommandContext context)
```
    Test whether this command is to be visualized in the current context
    
    Parameters:
    
    context -
    
    Returns:
    
    true if to be visualized, otherwise false
  - execute
```
void execute(CommandContext commandContext)
```
    Execute command for given CommandContext
    
    Parameters:
    
    commandContext - the CommandContext
  - executeWrapped
```
void executeWrapped(CommandContext commandContext)
```
    Execute command for given ActionContext. This method should be used by ToolBar, ContextMenu etc in order to allow for additional actions to be performed before/after command execution.
    
    Parameters:
    
    commandContext - the CommandContext

Interface Command

Field Summary

Method Summary

Methods inherited from interface com.softwareag.cis.plugin.interfaces.Component

Field Detail

rcs_id

CATEGORY_MIN

CATEGORY_OPEN

CATEGORY_EDIT

CATEGORY_SAVE

CATEGORY_NEW

CATEGORY_DELETE

CATEGORY_UPDATE

CATEGORY_UPDATE_EXT

CATEGORY_COPY

CATEGORY_LCM

CATEGORY_OBJECT

CATEGORY_DOCUMENT

CATEGORY_FAVORITES

CATEGORY_IMPORT_EXPORT

CATEGORY_APPLICATION_HIGH_PRIO

CATEGORY_EXECUTE

CATEGORY_LINK

CATEGORY_PREFERENCES

CATEGORY_SHOW

CATEGORY_VIEW

CATEGORY_SEARCH

CATEGORY_APPLICATION_LOW_PRIO

CATEGORY_MISC

COMMAND_SHOW_DETAILS

COMMAND_EDIT_DETAILS

COMMAND_RENAME

COMMAND_PERMISSIONS

COMMAND_DELETE

COMMAND_CHANGE_LIFEC_STATE

COMMAND_LC_CREATE_NEW_VERS

COMMAND_ADD_TYPE

COMMAND_ADD_CATEGORY

COMMAND_REGISTER_CONS

COMMAND_IMPORT_ASSET

COMMAND_EXPORT

COMMAND_IMPACT_ANALYSIS

COMMAND_GENERATE_REPORT

COMMAND_ATTACH_WSDL

COMMAND_COMPARE

COMMAND_ADD_VERSION

COMMAND_ADD_COPY

COMMAND_CHECK_CONN

COMMAND_ACTIVATE_DEACTIVATE

COMMAND_NOTIFY_ME

COMMAND_EXPORT_CONTENTS

COMMAND_COPY_SHORTCUT

COMMAND_ADD_TO_LIST

COMMAND_DOWNLOAD

COMMAND_DOCUMENTATION

COMMAND_ADD_FOLDER

COMMAND_ADD_DOCUMENT

COMMAND_ADD_TO_FAVORITES

COMMAND_REMOVE_FROM_FAVORITES

COMMAND_RENAME_LIST

COMMAND_EXPORT_FAVORITE

COMMAND_VIRTUALIZE

COMMAND_REGISTER_AS_CONSUMER

COMMAND_ATTACH_WS_POLICY

COMMAND_CHANGE_PROVIDING_ORG

COMMAND_DOWNLOAD_WSDL

COMMAND_DOWNLOAD_BPEL

COMMAND_DOWNLOAD_XMLSCHEMA

Method Detail

getName

getImageURL

getCategory

isSameGroup

getSubCommands

setLocale

getLocale

isEnabled

isToBeVisualized

execute

executeWrapped