All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.hi.customizer.beans.scci.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, createMacroCommand, createMacro

Variable Index

 o CLOSE_WINDOW
Constant for setCommandType() Close window
 o FILE_DEFAULTS
Constant for setCommandType() File defaults
 o LAUNCH_MACRO
Constant for setCommandType() Launch macro file
 o NEW_SESSION
Constant for setCommandType() Start new session
 o NO_COMMAND
Constant for setCommandType() No command
 o NUMBER_COMMANDS
 o PERFORM_CALC
Constant for setCommandType() Perform calculation
 o RECEIVE_FILES
Constant for setCommandType() Receive files
 o RUN_APPLET
Constant for setCommandType() Run applet
 o SEND_FILES
Constant for setCommandType() Send files
 o SET_CURSOR
Constant for setCommandType() Set cursor

Method Index

 o getArgument()
Gets the argument.
 o getCommandType()
Gets the command type (one of the statically defined values above).
 o getCopyLength()
Gets the copy length.
 o getHostPosition()
Gets the host position.
 o setArgument(String)
Sets the optional argument to be used with the set command type.
 o setCommandType(int)
Sets the command type using the static values defined above.
 o setCopyLength(int)
Sets the copy length.
 o setHostPosition(int)
Sets the host position.

Variables

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

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

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

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

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

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

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

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

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

 o NUMBER_COMMANDS
 public static final int NUMBER_COMMANDS
 o NO_COMMAND
 public static final int NO_COMMAND
Constant for setCommandType() No command

Methods

 o setCommandType
 public abstract void setCommandType(int commandType) throws Exception
Sets the command type using the static values defined above.

Parameters:
commandType - the command type
Throws: Exception
if commandType is invalid.
 o getCommandType
 public abstract 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.
 o setArgument
 public abstract void setArgument(String argument)
Sets the optional argument to be used with the set command type.

Parameters:
argument - the argument
 o getArgument
 public abstract String getArgument()
Gets the argument.

Returns:
the argument, or null if no argument has been set.
 o setCopyLength
 public abstract void setCopyLength(int copyLength)
Sets the copy length.

Parameters:
copyLength - the copyLength
 o getCopyLength
 public abstract int getCopyLength()
Gets the copy length.

Returns:
the copyLength, or -1 if no copy length has be specified.
 o setHostPosition
 public abstract void setHostPosition(int hostPosition)
Sets the host position.

Parameters:
hostPosition - the host position
 o getHostPosition
 public abstract int getHostPosition()
Gets the host position.

Returns:
the host position, or -1 if no host position has be specified.

All Packages  Class Hierarchy  This Package  Previous  Next  Index