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

java.lang.Object
  extended by com.wrq.vhi.script.api.command.Command
      extended by com.wrq.vhi.script.api.command.WaitForCursorAtAttribute

public class WaitForCursorAtAttribute
extends Command

A class that represents a VHI WaitForCursorAtAttribute command.

See Also:
CommandList, HostSession.executeCommandList(com.wrq.vhi.script.api.command.CommandList), HostSession.waitForCursorAtAttribute(java.lang.String, java.lang.String, int)

Constructor Summary
WaitForCursorAtAttribute(java.lang.String entity, java.lang.String attribute, int timeout)
          Constructs a new WaitForCursorAtAttr command.
 
Method Summary
 java.lang.String getAttribute()
          Gets the attribute.
 java.lang.String getEntity()
          Gets the entity.
 java.lang.String getName()
          Gets the command name.
 int getTimeout()
          Gets the timeout.
 
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

WaitForCursorAtAttribute

public WaitForCursorAtAttribute(java.lang.String entity,
                                java.lang.String attribute,
                                int timeout)
Constructs a new WaitForCursorAtAttr command.

Parameters:
entity - the name of the entity on which the attribute is defined
attribute - the name of the attribute
timeout - the maximum time to wait in seconds
Method Detail

getEntity

public java.lang.String getEntity()
Gets the entity.

Returns:
the name of the entity on which the attribute is defined

getAttribute

public java.lang.String getAttribute()
Gets the attribute.

Returns:
the name of the attribute

getTimeout

public int getTimeout()
Gets the timeout.

Returns:
the maximum time to wait in seconds

getName

public java.lang.String getName()
Gets the command name.

Specified by:
getName in class Command
Returns:
the command name