Class Event.RowSet
Represents a set of a database table rows
Defined in: </home/ubuntu/streamscape/NeeveBuild/stjsapi/src/main/webapp/js/event/RowSet.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
Event.RowSet(descriptor)
Creates a new row set
|
Method Attributes | Method Name and Description |
---|---|
boolean |
absolute(row)
Moves the cursor to the given row number in this
RowSet object. |
void |
addRow(newRow)
Adds the specified row to this row set
|
void |
addRowTo(index, newRow)
Adds the specified row to this row set at the specified index
|
void |
Moves the cursor to the end of this
RowSet object,
just after the last row. |
void |
Moves the cursor to the front of this
RowSet object,
just before the first row. |
void |
deleteRow(index)
Deletes the row at the specified index
|
number |
findColumn(columnName)
Finds the the column index by the column name (indicies start from 1)
|
boolean |
first()
Moves the cursor to the first row in this
RowSet
object. |
Object |
getObject(columnIndex)
Gets the value of the designated column in the current row of this
|
Object |
getObjectByName(columnName)
Gets the value of the designated column in the current row of this
|
number |
getOutParameterIndex(name)
Returns the index of the specified out parameter
|
String |
getOutParameterName(index)
Returns the name of the out parameter specified by its index
|
Object |
getOutParameterValue(index)
Returns the value of the out parameter specified by its index
|
Object |
Returns the value of the out parameter specified by its name
|
Object |
Returns the return code value of this row set
|
number |
Retrieves the number of rows that this
RowSet
contains. |
Event.RowMetaData |
Returns the meta data describing a row in this row set
|
boolean |
Retrieves whether the cursor is after the last row in this
RowSet object. |
boolean |
Retrieves whether the cursor is before the first row in this
RowSet object. |
boolean |
isEmpty()
Returns if this row set is empty
|
boolean |
isFirst()
Retrieves whether the cursor is on the first row of this
RowSet object. |
boolean |
isLast()
Retrieves whether the cursor is on the last row of this
RowSet object. |
boolean |
last()
Moves the cursor to the last row in this
RowSet object. |
Event.Row |
newRow()
Returns a new row
|
boolean |
next()
Moves the cursor down one row from its current position.
|
boolean |
previous()
Moves the cursor to the previous row in this
RowSet
object. |
boolean |
relative(rows)
Moves the cursor a relative number of rows, either positive or
negative.
|
void |
setReturnCodeValue(code)
Sets the return code value of this row set
|
Class Detail
Event.RowSet(descriptor)
Creates a new row set
- Parameters:
- {Event.RowMetaData} descriptor
- The meta data describing a row in the row set to be created
Method Detail
{boolean}
absolute(row)
Moves the cursor to the given row number in this
RowSet
object.
- Parameters:
- {number} row
- The number of the row to which the cursor should move. A positive number indicates the row number counting from the beginning of the row set; a negative number indicates the row number counting from the end of the row set
- Returns:
true
if the cursor is on the row set;false
otherwise
addRow(newRow)
Adds the specified row to this row set
- Parameters:
- {Object[]} newRow
- The row to be added
addRowTo(index, newRow)
Adds the specified row to this row set at the specified index
- Parameters:
- {number} index
- The index where the new row should be placed
- {Object[]} newRow
- The row to be added
afterLast()
Moves the cursor to the end of this
RowSet
object,
just after the last row.
beforeFirst()
Moves the cursor to the front of this
RowSet
object,
just before the first row.
deleteRow(index)
Deletes the row at the specified index
- Parameters:
- {number} index
- The index of the row to be deleted
{number}
findColumn(columnName)
Finds the the column index by the column name (indicies start from 1)
- Parameters:
- {String} columnName
- The name of the column to be found
- Returns:
- The column index
{boolean}
first()
Moves the cursor to the first row in this
RowSet
object.
- Returns:
true
if the cursor is on a valid row;false
if there are no rows in the row set
{Object}
getObject(columnIndex)
Gets the value of the designated column in the current row of this
RowSet
object as an Object
.
- Parameters:
- {number} columnIndex
- The first column is 1, the second is 2, ...
- Returns:
- An
Object
holding the column value
{Object}
getObjectByName(columnName)
Gets the value of the designated column in the current row of this
RowSet
object as an Object
.
- Parameters:
- {String} columnName
- The name of the column
- Returns:
- An
Object
holding the column value
{number}
getOutParameterIndex(name)
Returns the index of the specified out parameter
- Parameters:
- {String} name
- The name of the out parameter
- Returns:
- The index in the array of the out parameters
{String}
getOutParameterName(index)
Returns the name of the out parameter specified by its index
- Parameters:
- {number} index
- The index of the out parameter
- Returns:
- The name the out parameter to be returned
{Object}
getOutParameterValue(index)
Returns the value of the out parameter specified by its index
- Parameters:
- {number} index
- The index of the out parameter
- Returns:
- The value the out parameter to be returned
{Object}
getOutParameterValueByName(name)
Returns the value of the out parameter specified by its name
- Parameters:
- {String} name
- The name of the out parameter
- Returns:
- The value the out parameter to be returned
{Object}
getReturnCodeValue()
Returns the return code value of this row set
- Returns:
- The return code value of this row set
{number}
getRowCount()
Retrieves the number of rows that this
RowSet
contains.
- Returns:
- the number of rows that this
RowSet
object contains
{Event.RowMetaData}
getRowMetaData()
Returns the meta data describing a row in this row set
- Returns:
- The meta data describing a row in this row set
{boolean}
isAfterLast()
Retrieves whether the cursor is after the last row in this
RowSet
object.
- Returns:
true
if the cursor is after the last row;false
if the cursor is at any other position or the row set contains no rows
{boolean}
isBeforeFirst()
Retrieves whether the cursor is before the first row in this
RowSet
object.
- Returns:
true
if the cursor is before the first row;false
if the cursor is at any other position or the row set contains no rows
{boolean}
isEmpty()
Returns if this row set is empty
- Returns:
- True if this row set is empty, false otherwise
{boolean}
isFirst()
Retrieves whether the cursor is on the first row of this
RowSet
object.
- Returns:
true
if the cursor is on the first row;false
otherwise
{boolean}
isLast()
Retrieves whether the cursor is on the last row of this
RowSet
object.
- Returns:
true
if the cursor is on the last row;false
otherwise
{boolean}
last()
Moves the cursor to the last row in this
RowSet
object.
- Returns:
true
if the cursor is on a valid row;false
if there are no rows in the row set
{Event.Row}
newRow()
Returns a new row
- Returns:
- A new row
{boolean}
next()
Moves the cursor down one row from its current position.
- Returns:
true
if the new current row is valid;false
if there are no more rows
{boolean}
previous()
Moves the cursor to the previous row in this
RowSet
object.
- Returns:
true
if the cursor is on a valid row;false
if it is off the row set
{boolean}
relative(rows)
Moves the cursor a relative number of rows, either positive or
negative.
- Parameters:
- {number} rows
- An
int
specifying the number of rows to move from the current row; a positive number moves the cursor forward; a negative number moves the cursor backward
- Returns:
true
if the cursor is on a row;false
otherwise
setReturnCodeValue(code)
Sets the return code value of this row set
- Parameters:
- {Object} code
- The return code to be set