com.wrq.vhi.script.api
Interface RecordSetContext

public interface RecordSetContext

Stores state information for a recordset and its records. The state is automatically cleared when a fetch completes.

Method Summary

java.lang.String	getEntityName() Gets the entity name.
java.lang.String	getRecordSetName() Gets the record set name.
java.lang.Object	getRecordSetStateObject(java.lang.String name) Gets the recordset context object bound to the specified name, or null if no object is bound.
java.lang.Object	getRecordStateObject(int record, java.lang.String name) Gets the object bound to the specified name in the record context, or null if no object is bound to the name.
boolean	isRecordSetStateObject(java.lang.String name) Tests for the presence of a recordset context object bound to the specified name.
boolean	isRecordStateObject(int record, java.lang.String name) Tests for the presence of a record context object bound to the specified name.
void	setRecordSetStateObject(java.lang.String name, java.lang.Object object) Binds an object to this record set context, using the name specified.
void	setRecordStateObject(int record, java.lang.String name, java.lang.Object object) Binds an object to this record context, using the name specified.

Method Detail

getEntityName

java.lang.String getEntityName()

Gets the entity name.

Returns:

the name of the entity

getRecordSetName

java.lang.String getRecordSetName()

Gets the record set name.

Returns:

the name of the record set

isRecordSetStateObject

boolean isRecordSetStateObject(java.lang.String name)

Tests for the presence of a recordset context object bound to the specified name.

Parameters:

name - the name of the object

Returns:

true if an object is bound to the specified name

getRecordSetStateObject

java.lang.Object getRecordSetStateObject(java.lang.String name)

Gets the recordset context object bound to the specified name, or null if no object is bound.

Parameters:

name - the name of the object

Returns:

the object bound to the specified name or null if none

setRecordSetStateObject

void setRecordSetStateObject(java.lang.String name,
                             java.lang.Object object)

Binds an object to this record set context, using the name specified. If an object of the same name is already bound to the record set context, the object is replaced.

Parameters:

name - the name of the object

object - the object to bind

isRecordStateObject

boolean isRecordStateObject(int record,
                            java.lang.String name)

Tests for the presence of a record context object bound to the specified name.

Parameters:

record - index of the record

name - the name of the object

Returns:

true if an object is bound to the specified name

getRecordStateObject

java.lang.Object getRecordStateObject(int record,
                                      java.lang.String name)

Gets the object bound to the specified name in the record context, or null if no object is bound to the name.

Parameters:

record - index of the record

name - the name of the object

Returns:

the object bound to the specified name or null if none

setRecordStateObject

void setRecordStateObject(int record,
                          java.lang.String name,
                          java.lang.Object object)

Binds an object to this record context, using the name specified. If an object of the same name is already bound to the record set context, the object is replaced.

Parameters:

record - index of the record

name - the name to which to bind the object

object - the object to bind