Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center
11g Release 1 (11.1.1.7.0)
E14128-06

oracle.alm.connector.data
Class Row

java.lang.Object
  extended by oracle.alm.connector.data.Row
Direct Known Subclasses:
WorkItem

public class Row
extends java.lang.Object

Row represents a generic data row. It contains runtime data from connector's backend repository.

Since:
11.1.1.1.0
See Also:
WorkItem

Constructor Summary
Row()
          Sole constructor.
 
Method Summary
 void display()
          helper method to display the row in the JDeveloper Message Log window.
 java.util.Map<java.lang.String,ListItem> getListData()
          Retrieves the list data for all fields in current row.
 java.lang.String getRowKey()
          Retrieves the key that uniquely identifies the row data.
 java.util.Map<java.lang.String,java.lang.Object> getSubmittedValues()
          Retrieves list of submitted values to be sent to the connector backend from OTPC client.
 java.util.Map<java.lang.String,java.lang.Object> getValues()
          Retrieves values for all fields in current row as returned by the backend repository.
 boolean isDirty()
          Determines if the row has been modified.
 boolean isNew()
          Determines if the row is a newly created row.
 void setDirty(boolean dirty)
          Marks the row data as modified or needs update.
 void setListData(java.lang.String name, ListItem listData)
          Sets ListItem data for a field in the row.
 void setNew(boolean isNew)
          Marks the row as new if it is a newly created record.
 void setRowKey(java.lang.String rowKey)
          Sets the key used to uniquely identify the row.
 void setSubmittedValue(java.lang.String name, java.lang.Object submittedValue)
          Sets a submitted value for a field
 void setValue(java.lang.String name, java.lang.Object value)
          Sets the value for the specified field.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Row

public Row()
Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

setRowKey

public void setRowKey(java.lang.String rowKey)

Sets the key used to uniquely identify the row.

Parameters:
rowKey - unique identifier for a row

getRowKey

public java.lang.String getRowKey()

Retrieves the key that uniquely identifies the row data.

Returns:
unique identifier or key for the row

getValues

public java.util.Map<java.lang.String,java.lang.Object> getValues()

Retrieves values for all fields in current row as returned by the backend repository.

Returns:
a map consists of name and value pair for all fields in the row.

getListData

public java.util.Map<java.lang.String,ListItem> getListData()

Retrieves the list data for all fields in current row.

Returns:
listItems for all fields in the row that are to be rendered in UI controls such as choice (pickList), radioGroup, list, etc.

getSubmittedValues

public java.util.Map<java.lang.String,java.lang.Object> getSubmittedValues()

Retrieves list of submitted values to be sent to the connector backend from OTPC client.

Returns:
map of submitted values from a connector UI page on the client. These values will be sent to connector backend by the framework. This method is typically called by connector UI framework (not by connector code). TODO: will revisit in next release.

setValue

public void setValue(java.lang.String name,
                     java.lang.Object value)

Sets the value for the specified field.

Parameters:
name - name of the field to set
value - the value for the field

setListData

public void setListData(java.lang.String name,
                        ListItem listData)

Sets ListItem data for a field in the row. The data will be rendered in the connector UI as a choice (pickList), radioGroup, list, or others.

Parameters:
name - name of the field to set
listData - the list of data for the field

setSubmittedValue

public void setSubmittedValue(java.lang.String name,
                              java.lang.Object submittedValue)

Sets a submitted value for a field

Parameters:
name - name of the field
submittedValue - the value submitted on the connector UI page as recorded by OTPC client. This value will be sent to connector backend repository by connector framework. This method is typically called by the framework (not by connector code). TODO: will revisit in next release.

setNew

public void setNew(boolean isNew)

Marks the row as new if it is a newly created record.

Parameters:
isNew - indicates if the record is new or old

isNew

public boolean isNew()

Determines if the row is a newly created row.

Returns:
true if the row is new, else false

setDirty

public void setDirty(boolean dirty)

Marks the row data as modified or needs update.

Parameters:
dirty - indicates if the row data is modified

isDirty

public boolean isDirty()

Determines if the row has been modified.

Returns:
true if the row is modified, else false

display

public void display()
helper method to display the row in the JDeveloper Message Log window.


Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center
11g Release 1 (11.1.1.7.0)
E14128-06

Copyright © 1999, 2013, Oracle. All rights reserved.