Package com.im.df.api.support

Class RowSetData

java.lang.Object

com.im.df.api.support.RowSetData

public final class RowSetData
extends java.lang.Object

Deprecated.

DO NOT USE THIS STRUCTURE. Use DFInsertDescription instead.

Represents a set of data that is to be inserted in the database as a single atomic event. Typically this would be a single entry, consisting of rows in multiple database tables that are related to each other (e.g. master-detail data related through foreign key constraints) and define a single self-consistent set of data. All updates would be expected to occur in a single transaction.

Note: This is not API stable class, can be changed in the future.

Author:

Tim Dudgeon

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RowSetData.MultiRowData	Deprecated. Data for a set of rows that are to be inserted
static class	RowSetData.RelatedData	Deprecated. Data whose insertion has a dependency on some other data, either needing to be inserted prior to or subsequent to the data.
class	RowSetData.Row	Deprecated. An individual row whose values can be set
class	RowSetData.RowData	Deprecated.
class	RowSetData.SingleRowData	Deprecated. Data for a set of rows that are to be inserted

Constructor Summary

Constructors

Constructor	Description
RowSetData(java.lang.String entityID, java.lang.String lookupFieldID, com.im.commons.progress.DFLock lock, java.util.Map<java.lang.String,java.lang.Object> insertOptions)	Deprecated. Creates a new RowSetData.

Method Summary

Modifier and Type	Method	Description
RowSetData.RowData	getData()	Deprecated.
java.lang.String	getEntityID()	Deprecated.
java.util.Map<java.lang.String,java.lang.Object>	getInsertOptions()	Deprecated.
com.im.commons.progress.DFLock	getLock()	Deprecated. Get the DFEntityDataProvider's lock
java.lang.String	getLookupFieldID()	Deprecated.
java.lang.String	toString()	Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RowSetData

public RowSetData(java.lang.String entityID,
                  java.lang.String lookupFieldID,
                  com.im.commons.progress.DFLock lock,
                  java.util.Map<java.lang.String,java.lang.Object> insertOptions)

Deprecated.

Creates a new RowSetData.

Parameters:

entityID - The ID of the entity

lookupFieldID - The field that contains the value that is used for identity determination (e.g does this row already exist in the DB)

lock - The DFEntityDataProvider's lock

insertOptions - Any options for inserting. Can be null.

Method Detail

getLookupFieldID

public java.lang.String getLookupFieldID()

Deprecated.

Returns:

The ID of the field to lookup the (possibly) existing value from

toString

public java.lang.String toString()

Deprecated.

Overrides:

toString in class java.lang.Object

getEntityID

public java.lang.String getEntityID()

Deprecated.

Returns:

The ID of the entity that the rows belong to

getLock

public com.im.commons.progress.DFLock getLock()

Deprecated.

Get the DFEntityDataProvider's lock

getInsertOptions

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

Deprecated.

getData

public RowSetData.RowData getData()

Deprecated.

Returns:

The data to insert.