com.highqsoft.odsx.hql

Interface CommandInterface

All Superinterfaces:

FwkCommandInterface, FwkControlledByInterface, FwkInstructionInterface, FwkInterface, FwkPresentationInterface, FwkPropertyChangeInterface, java.io.Serializable

All Known Implementing Classes:

Cmd, CmdClose, CmdConnect, CmdDescribe, CmdEcho, CmdExit, CmdHelp, CmdJournal, CmdList, CmdSelect, CmdSource

public interface CommandInterface
extends FwkCommandInterface

The command interface. It describe the basic functionality that a HQL must implement.

Author:

Andreas Hofmann $Revision: 1.11 $ $Date: 2017/04/06 13:29:54 $

Field Summary

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkCommandInterface

CONTROLLER_PROPERTY, MENU_REASON_CANCELED, MENU_REASON_DESELECTED, MENU_REASON_SELECTED

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	commandString() The command string.
boolean	execute() Execute the command.
OdsxResultSetInterface	getResult() Get the result columns of the command.
boolean	initializeExecution() Initialize execution.
boolean	parseParams(java.lang.String params) Set the parameter string to the command.
void	setInterpreter(HQL hql) Set the interpreter.
void	terminateExecution() Terminate execution.
long	timeNeeded() Get the time in milli seconds needed by execution.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkCommandInterface

addActionListener, addMenuListener, execute, getActionListenerArray, getButtonClass, getCommandName, getHelpID, getIcon, getIconKey, getMenuEventEnabled, getMenuItemClass, getMenuListenerArray, getMnemonic, getProperties, getProperty, getRadioGroupState, getSensitivity, getSeparator, getText, getTextKey, getToggle, getToggleState, getToolBarEnabled, getToolTipKey, getToolTipText, getVisibility, hasActionListeners, hasMenuListeners, isParent, menuSelect, register, registeredObjects, registrySize, removeActionListener, removeMenuListener, setAsParent, setButtonClass, setCommandName, setHelpID, setIcon, setIconKey, setMenuEventEnabled, setMenuItemClass, setMnemonic, setProperty, setRadioGroupState, setSensitivity, setSeparator, setText, setTextKey, setToggle, setToggleState, setToolBarEnabled, setToolTipKey, setToolTipText, setVisibility, unregister

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getCommands, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControlledByInterface

getController, setController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Method Detail

parseParams

boolean parseParams(java.lang.String params)

Set the parameter string to the command.

Parameters:

params - the param string to be parsed.

Returns:

true if successful.

commandString

java.lang.String commandString()

The command string.

setInterpreter

void setInterpreter(HQL hql)

Set the interpreter.

Parameters:

hql - the hql interpreter.

execute

boolean execute()

Execute the command.

Returns:

true if successful.

getResult

OdsxResultSetInterface getResult()

Get the result columns of the command.

Returns:

the result columns.

initializeExecution

boolean initializeExecution()

Initialize execution.

Returns:

true if the command was already executed.

terminateExecution

void terminateExecution()

Terminate execution.

timeNeeded

long timeNeeded()

Get the time in milli seconds needed by execution.

Returns:

the elapsed time.