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

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

public class WaitForCursorAtRecordSetField
extends Command

A class that represents a VHI WaitForCursorAtRecordSetField command.

See Also:

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

Constructor Summary

WaitForCursorAtRecordSetField(java.lang.String entity, java.lang.String recordSet, java.lang.String field, int timeout)
Constructs a new WaitForCursorAtRSField command.

Method Summary

java.lang.String	getEntity() Gets the entity name.
java.lang.String	getField() Gets the field name.
java.lang.String	getName() Gets the command name.
java.lang.String	getRecordSet() Gets the record set 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

WaitForCursorAtRecordSetField

public WaitForCursorAtRecordSetField(java.lang.String entity,
                                     java.lang.String recordSet,
                                     java.lang.String field,
                                     int timeout)

Constructs a new WaitForCursorAtRSField command.

Parameters:

entity - the name of the entity on which the recordset is defined

recordSet - the name of the record set on which the field is defined

field - the name of the field that can terminate the wait

timeout - the maximum time to wait in seconds

Method Detail

getEntity

public java.lang.String getEntity()

Gets the entity name.

Returns:

the name of the entity on which the recordset is defined

getRecordSet

public java.lang.String getRecordSet()

Gets the record set name.

Returns:

the name of the record set on which the field is defined

getField

public java.lang.String getField()

Gets the field name.

Returns:

the name of the field that can terminate the wait

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