ResultSet object methods
The following list summarizes the ResultSet object methods:
Note: For all Perl Get and Set methods, see the Properties section of
this object.
- Method name
- Description
AddParamValue- Assigns one or more values to a parameter.
ClearParamValues- Clears all values associated with a parameter.
EnableRecordCount- Enables a record count for the result set.
Execute- Runs the query and fills the result set with data.
ExecuteAndCountRecords- Runs the query, fills the result set with data, and returns the record count (the number of rows) of the result set.
ExecuteAndSave- Executes a query and saves the result set as a file.
GetAllColumnValues- Returns all column values in the result set.
GetColumnLabel- Returns the heading text for the specified column.
GetColumnType- Returns the type of data stored in the specified column.
GetColumnValue- Returns the value stored in the specified column of the current row.
GetConvertToLocalTime- Returns the convert-to-local-time property of the ResultSet object.
GetNumberOfColumns- Returns the number of columns in each row of the result set.
GetNumberOfParams- Returns the number of parameters in this query.
GetParamChoiceList- Returns a list of permitted values for the parameter.
GetParamComparisonOperator- Returns the comparison operator associated with the parameter.
GetParamFieldType- Returns the field type of the parameter.
GetParamLabel- Returns the name of the parameter.
GetParamPrompt- Returns the prompt string displayed to the user for the given parameter.
GetQueryLimit- Returns the hard or soft query limit set for the session.
GetRowEntityDefName- Based on the result set, this method returns a String with the record type (EntityDef) name of the current row.
GetSQL- Returns the SQL string that expresses the query.
LookupPrimaryEntityDefName- Returns the name of the EntityDef object on which the query is based.
MoveNext- Moves the to the next record in the data set.
ResultSetIsLimited- Returns a Long that indicates whether or not the result set is limited. Returns the number of rows returned if limited, or 0 (zero) if not limited.
SetConvertToLocalTime- Enables or disables the convert-to-local-time property of the ResultSet object.
SetParamComparisonOperator- Sets the comparison operator associated with the parameter.