com.wrq.apptrieve.appconn
Class RecordSetMetaData

java.lang.Object
  extended by com.wrq.apptrieve.appconn.RecordSetMetaData
All Implemented Interfaces:
AppConnMetaData

public class RecordSetMetaData
extends java.lang.Object
implements AppConnMetaData

Provides metadata about a recordset that is defined on an entity of a Host Integrator model.


Field Summary
static int SCROLL_TYPE_END
          Key value in the Map returned from getScrollOperations() for the End operation.
static int SCROLL_TYPE_HOME
          Key value in the Map returned from getScrollOperations() for the Home operation.
static int SCROLL_TYPE_LINEDOWN
          Key value in the Map returned from getScrollOperations() for the LineDown operation.
static int SCROLL_TYPE_LINEUP
          Key value in the Map returned from getScrollOperations() for the LineUp operation.
static int SCROLL_TYPE_PAGEDOWN
          Key value in the Map returned from getScrollOperations() for the PageDown operation.
static int SCROLL_TYPE_PAGEUP
          Key value in the Map returned from getScrollOperations() for the PageUp operation.
 
Fields inherited from interface com.wrq.apptrieve.appconn.AppConnMetaData
METADATA_TYPE_ATTRIBUTE, METADATA_TYPE_COLUMN, METADATA_TYPE_FIELD, METADATA_TYPE_OPERATION, METADATA_TYPE_PROCEDURE, METADATA_TYPE_RECORDSET, METADATA_TYPE_VARIABLE
 
Constructor Summary
RecordSetMetaData(com.wrq.apptrieve.agent.EntityRecordsetMeta saObject)
          Constructor for internal use only.
 
Method Summary
 java.lang.String getDescription()
          Gets the description of the record set.
 java.util.List getFieldNames()
          Gets the field names for the record set.
 int getMetaDataType()
          Gets the meta data type for this object.
 java.lang.String getName()
          Gets the record set name.
 java.util.Map getScrollOperations()
          Gets the available scroll operations for the record set.
 boolean supportsDirectInserts()
          Discovers whether the recordset supports direct inserts.
 boolean supportsSelect()
          Discovers whether the recordset supports the select operation.
 java.lang.String toString()
          Generates a String object that represents the current values of this RecordSetMetaData object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SCROLL_TYPE_END

public static final int SCROLL_TYPE_END
Key value in the Map returned from getScrollOperations() for the End operation.

See Also:
Constant Field Values

SCROLL_TYPE_HOME

public static final int SCROLL_TYPE_HOME
Key value in the Map returned from getScrollOperations() for the Home operation.

See Also:
Constant Field Values

SCROLL_TYPE_LINEDOWN

public static final int SCROLL_TYPE_LINEDOWN
Key value in the Map returned from getScrollOperations() for the LineDown operation.

See Also:
Constant Field Values

SCROLL_TYPE_LINEUP

public static final int SCROLL_TYPE_LINEUP
Key value in the Map returned from getScrollOperations() for the LineUp operation.

See Also:
Constant Field Values

SCROLL_TYPE_PAGEDOWN

public static final int SCROLL_TYPE_PAGEDOWN
Key value in the Map returned from getScrollOperations() for the PageDown operation.

See Also:
Constant Field Values

SCROLL_TYPE_PAGEUP

public static final int SCROLL_TYPE_PAGEUP
Key value in the Map returned from getScrollOperations() for the PageUp operation.

See Also:
Constant Field Values
Constructor Detail

RecordSetMetaData

public RecordSetMetaData(com.wrq.apptrieve.agent.EntityRecordsetMeta saObject)
Constructor for internal use only.

Parameters:
saObject - data
Method Detail

getDescription

public java.lang.String getDescription()
Gets the description of the record set.

Specified by:
getDescription in interface AppConnMetaData
Returns:
String the description

getFieldNames

public java.util.List getFieldNames()
Gets the field names for the record set.

Returns:
List - each item is a String object containing a field name in the record set

getMetaDataType

public int getMetaDataType()
Gets the meta data type for this object.

Specified by:
getMetaDataType in interface AppConnMetaData
Returns:
int - always returns AppConnMetaData.METADATA_TYPE_RECORDSET

getName

public java.lang.String getName()
Gets the record set name.

Specified by:
getName in interface AppConnMetaData
Returns:
String - the name of the recordset

getScrollOperations

public java.util.Map getScrollOperations()
Gets the available scroll operations for the record set.

The returned Map object contains key-value pairs, where the key is an Integer object that contains a scroll operation type and the value is a String object containing the name of an entity operation. The key can be one of the following:

Returns:
java.util.Map - the scroll operations defined for the recordset.
See Also:
AppConnModel.moveCurrentRecordIndex(int)

supportsDirectInserts

public boolean supportsDirectInserts()
Discovers whether the recordset supports direct inserts.

Returns:
boolean true if the recordset supports direct inserts

supportsSelect

public boolean supportsSelect()
Discovers whether the recordset supports the select operation.

Returns:
boolean true if the recordset supports the select operation

toString

public java.lang.String toString()
Generates a String object that represents the current values of this RecordSetMetaData object.

Overrides:
toString in class java.lang.Object
Returns:
java.lang.String - the string representation of this object