com.wrq.vhi.script.api.command
Class DefaultValue

java.lang.Object
  com.wrq.vhi.script.api.command.Command
      com.wrq.vhi.script.api.command.DefaultValue

public class DefaultValue
extends Command

A class that represents a VHI DefaultValue command.

See Also:

CommandList, HostSession.executeCommandList(com.wrq.vhi.script.api.command.CommandList), HostSession.defaultValue(java.lang.String, java.lang.String, int)

Constructor Summary

DefaultValue(java.lang.String attribute, java.lang.String value, int context)
Constructs a new DefaultValue command.

Method Summary

java.lang.String	getAttribute() Gets the attribute name.
int	getContext() Gets the context for the command.
java.lang.String	getName() Gets the command name.
java.lang.String	getValue() Gets the default value.

Methods inherited from class com.wrq.vhi.script.api.command.Command

isValidEchoType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultValue

public DefaultValue(java.lang.String attribute,
                    java.lang.String value,
                    int context)

Constructs a new DefaultValue command.

Parameters:

attribute - name of attribute to be modified

value - the value to be transmitted

context - selects when the command will be executed:

• HostSession.DESIGN_TOOL_ONLY - perform only in the design tool
• HostSession.DESIGN_TOOL_AND_SERVER - perform in both the design tool and server

Method Detail

getAttribute

public java.lang.String getAttribute()

Gets the attribute name.

Returns:

the attribute name

getValue

public java.lang.String getValue()

Gets the default value.

Returns:

the default value

getContext

public int getContext()

Gets the context for the command. The context is one of the following values:

• HostSession.DESIGN_TOOL_ONLY - perform only in the design tool
• HostSession.DESIGN_TOOL_AND_SERVER - perform in both the design tool and server

Returns:

the command context

getName

public java.lang.String getName()

Gets the command name.

Specified by:

getName in class Command

Returns:

the command name