com.ibm.hi.customizer.beans.scci
Interface SCMacroCommand


public interface SCMacroCommand

SCMacroCommand.java Description: contains command infomation for one line of an SCMacro. There are 8 different command types, some of which require various combinations of arguments, hostPosition information or copyLength information. SCMacroCommands and SCMacros may be created using methods in the SCFactory class.

See Also:
SCMacro, SCFactory.createMacroCommand(int, java.lang.String), SCFactory.createMacro(java.util.Vector, java.lang.String)

Field Summary
static int CLOSE_WINDOW
          Constant for setCommandType() Close window
static int FILE_DEFAULTS
          Constant for setCommandType() File defaults
static int LAUNCH_MACRO
          Constant for setCommandType() Launch macro file
static int NEW_SESSION
          Constant for setCommandType() Start new session
static int NO_COMMAND
          Constant for setCommandType() No command
static int NUMBER_COMMANDS
           
static int PERFORM_CALC
          Constant for setCommandType() Perform calculation
static int RECEIVE_FILES
          Constant for setCommandType() Receive files
static int RUN_APPLET
          Constant for setCommandType() Run applet
static int SEND_FILES
          Constant for setCommandType() Send files
static int SET_CURSOR
          Constant for setCommandType() Set cursor
 
Method Summary
 java.lang.String getArgument()
          Gets the argument.
 int getCommandType()
          Gets the command type (one of the statically defined values above).
 int getCopyLength()
          Gets the copy length.
 int getHostPosition()
          Gets the host position.
 void setArgument(java.lang.String argument)
          Sets the optional argument to be used with the set command type.
 void setCommandType(int commandType)
          Sets the command type using the static values defined above.
 void setCopyLength(int copyLength)
          Sets the copy length.
 void setHostPosition(int hostPosition)
          Sets the host position.
 

Field Detail

SET_CURSOR

public static final int SET_CURSOR
Constant for setCommandType() Set cursor

CLOSE_WINDOW

public static final int CLOSE_WINDOW
Constant for setCommandType() Close window

PERFORM_CALC

public static final int PERFORM_CALC
Constant for setCommandType() Perform calculation

LAUNCH_MACRO

public static final int LAUNCH_MACRO
Constant for setCommandType() Launch macro file

NEW_SESSION

public static final int NEW_SESSION
Constant for setCommandType() Start new session

RUN_APPLET

public static final int RUN_APPLET
Constant for setCommandType() Run applet

SEND_FILES

public static final int SEND_FILES
Constant for setCommandType() Send files

RECEIVE_FILES

public static final int RECEIVE_FILES
Constant for setCommandType() Receive files

FILE_DEFAULTS

public static final int FILE_DEFAULTS
Constant for setCommandType() File defaults

NUMBER_COMMANDS

public static final int NUMBER_COMMANDS

NO_COMMAND

public static final int NO_COMMAND
Constant for setCommandType() No command
Method Detail

setCommandType

public void setCommandType(int commandType)
                    throws java.lang.Exception
Sets the command type using the static values defined above.
Parameters:
commandType - the command type
Throws:
java.lang.Exception - if commandType is invalid.

getCommandType

public int getCommandType()
Gets the command type (one of the statically defined values above).
Returns:
the command type, or NO_COMMAND if no command has been set.

setArgument

public void setArgument(java.lang.String argument)
Sets the optional argument to be used with the set command type.
Parameters:
argument - the argument

getArgument

public java.lang.String getArgument()
Gets the argument.
Returns:
the argument, or null if no argument has been set.

setCopyLength

public void setCopyLength(int copyLength)
Sets the copy length.
Parameters:
copyLength - the copyLength

getCopyLength

public int getCopyLength()
Gets the copy length.
Returns:
the copyLength, or -1 if no copy length has be specified.

setHostPosition

public void setHostPosition(int hostPosition)
Sets the host position.
Parameters:
hostPosition - the host position

getHostPosition

public int getHostPosition()
Gets the host position.
Returns:
the host position, or -1 if no host position has be specified.