com.scooterframework.orm.sqldataexpress.object
Class OmniDTO

java.lang.Object
  extended by com.scooterframework.orm.sqldataexpress.object.OmniDTO
All Implemented Interfaces:
OmniDTOBasic, OmniDTOJdbcStatement, OmniDTOStoredFunction, OmniDTOStoredProcedure, java.io.Serializable

public class OmniDTO
extends java.lang.Object
implements OmniDTOJdbcStatement, OmniDTOStoredProcedure, OmniDTOStoredFunction

OmniDTO class.

See Also:
Serialized Form

Field Summary
static java.lang.String GENERATED_KEY
           
static java.lang.String MESSAGE_KEY
           
static java.lang.String NEWUPDATEDATE_KEY
           
static java.lang.String RETURN_CODE_KEY
           
static java.lang.String UPDATED_ROW_COUNT
           
 
Constructor Summary
OmniDTO()
           
 
Method Summary
 void addChildrenOmniDTOToList(OmniDTO returnTO)
          adds a childrenOmniDTO to List
 void addChildrenOmniDTOToMap(java.lang.String key, OmniDTO returnTO)
          adds a childrenOmniDTO to Map
 void addNamedObject(java.lang.String name, java.lang.Object value)
          adds a (name,value) pair to resultMap
 void addTableData(java.lang.String tableName, TableData tableData)
          adds a TableData
 OmniDTO getChildrenOmniDTOFromList(int index)
          returns childrenOmniDTO from List
 OmniDTO getChildrenOmniDTOFromMap(java.lang.String key)
          returns childrenOmniDTO from Map
 java.util.List<OmniDTO> getChildrenOmniDTOList()
          returns childrenOmniDTOList
 java.util.Map<java.lang.String,OmniDTO> getChildrenOmniDTOMap()
          returns childrenOmniDTOMap
 java.lang.Object getFunctionCallResult()
          returns result from database function call.
 long getGeneratedKey()
          returns generated key value as long.
 java.lang.String getMethodNamesSupportingFunctionProcessorOnly()
          Returns method names that are only useful when the underlying processor is a FunctionProcessor.
 java.lang.String getMethodNamesSupportingJdbcStatementProcessorOnly()
          Returns method names that are only useful when the underlying processor is a JdbcStatementProcessor.
 java.lang.String getMethodNamesSupportingStoredProcedureProcessorOnly()
          Returns method names that are only useful when the underlying processor is a StoredProcedureProcessor.
 java.util.Date getNewUpdateDate()
          returns newUpdateDate
 java.lang.String getProcessorName()
          returns processor name
 java.lang.String getProcessorType()
          returns processor type
 java.util.Map<java.lang.String,java.lang.Object> getResultObjectMap()
          The resultObjectMap is a Map which contains non-cursor result.
 java.lang.String getReturnCode()
          returns returnCode
 java.lang.String getReturnMessage()
          returns returnMessage
 TableData getTableData(java.lang.String key)
          returns tableData corresponding to the key of the tableDataMap.
 java.util.Map<java.lang.String,TableData> getTableDataMap()
          returns tableDataMap.
 int getUpdatedRowCount()
          returns updatedRowCount
 void setGeneratedKey(long generatedKey)
          sets getGeneratedKey
 void setProcessorName(java.lang.String processorName)
          sets processor name
 void setProcessorType(java.lang.String processorType)
          sets processor type
 void setUpdatedRowCount(int updatedRowCount)
          sets updatedRowCount
 java.lang.String toString()
          Returns a string representation of the object.
 java.lang.String toXML()
          Returns a XML string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RETURN_CODE_KEY

public static final java.lang.String RETURN_CODE_KEY
See Also:
Constant Field Values

MESSAGE_KEY

public static final java.lang.String MESSAGE_KEY
See Also:
Constant Field Values

NEWUPDATEDATE_KEY

public static final java.lang.String NEWUPDATEDATE_KEY
See Also:
Constant Field Values

UPDATED_ROW_COUNT

public static final java.lang.String UPDATED_ROW_COUNT
See Also:
Constant Field Values

GENERATED_KEY

public static final java.lang.String GENERATED_KEY
See Also:
Constant Field Values
Constructor Detail

OmniDTO

public OmniDTO()
Method Detail

getReturnCode

public java.lang.String getReturnCode()
returns returnCode

Specified by:
getReturnCode in interface OmniDTOStoredProcedure

getReturnMessage

public java.lang.String getReturnMessage()
returns returnMessage

Specified by:
getReturnMessage in interface OmniDTOStoredProcedure

getNewUpdateDate

public java.util.Date getNewUpdateDate()
returns newUpdateDate

Specified by:
getNewUpdateDate in interface OmniDTOStoredProcedure

getUpdatedRowCount

public int getUpdatedRowCount()
returns updatedRowCount

Specified by:
getUpdatedRowCount in interface OmniDTOJdbcStatement

setUpdatedRowCount

public void setUpdatedRowCount(int updatedRowCount)
sets updatedRowCount

Specified by:
setUpdatedRowCount in interface OmniDTOJdbcStatement

getGeneratedKey

public long getGeneratedKey()
returns generated key value as long. Note: Only one primary key column is allowed to be auto generated. return -1 if the underlying database does not support generatedKeys feature or if the sql statement is not a ddl statement.

Specified by:
getGeneratedKey in interface OmniDTOJdbcStatement

setGeneratedKey

public void setGeneratedKey(long generatedKey)
sets getGeneratedKey

Specified by:
setGeneratedKey in interface OmniDTOJdbcStatement

getProcessorName

public java.lang.String getProcessorName()
returns processor name

Specified by:
getProcessorName in interface OmniDTOBasic

setProcessorName

public void setProcessorName(java.lang.String processorName)
sets processor name

Specified by:
setProcessorName in interface OmniDTOBasic

getProcessorType

public java.lang.String getProcessorType()
returns processor type

Specified by:
getProcessorType in interface OmniDTOBasic

setProcessorType

public void setProcessorType(java.lang.String processorType)
sets processor type

Specified by:
setProcessorType in interface OmniDTOBasic

getResultObjectMap

public java.util.Map<java.lang.String,java.lang.Object> getResultObjectMap()
The resultObjectMap is a Map which contains non-cursor result. returns resultObjectMap

Specified by:
getResultObjectMap in interface OmniDTOStoredProcedure

addNamedObject

public void addNamedObject(java.lang.String name,
                           java.lang.Object value)
adds a (name,value) pair to resultMap

Specified by:
addNamedObject in interface OmniDTOStoredProcedure

getFunctionCallResult

public java.lang.Object getFunctionCallResult()
returns result from database function call. returns Object result from the database function call

Specified by:
getFunctionCallResult in interface OmniDTOStoredFunction

getTableData

public TableData getTableData(java.lang.String key)
returns tableData corresponding to the key of the tableDataMap. The key is by default the name of the cursor.

Specified by:
getTableData in interface OmniDTOBasic

getTableDataMap

public java.util.Map<java.lang.String,TableData> getTableDataMap()
returns tableDataMap. The TableDataMap is a Map that contains output for every cursor. The key is the name of the cursor. The value is a TableData.

Specified by:
getTableDataMap in interface OmniDTOBasic

addTableData

public void addTableData(java.lang.String tableName,
                         TableData tableData)
adds a TableData

Specified by:
addTableData in interface OmniDTOBasic

getChildrenOmniDTOFromList

public OmniDTO getChildrenOmniDTOFromList(int index)
returns childrenOmniDTO from List

Specified by:
getChildrenOmniDTOFromList in interface OmniDTOBasic

getChildrenOmniDTOList

public java.util.List<OmniDTO> getChildrenOmniDTOList()
returns childrenOmniDTOList

Specified by:
getChildrenOmniDTOList in interface OmniDTOBasic

addChildrenOmniDTOToList

public void addChildrenOmniDTOToList(OmniDTO returnTO)
adds a childrenOmniDTO to List

Specified by:
addChildrenOmniDTOToList in interface OmniDTOBasic

getChildrenOmniDTOFromMap

public OmniDTO getChildrenOmniDTOFromMap(java.lang.String key)
returns childrenOmniDTO from Map

Specified by:
getChildrenOmniDTOFromMap in interface OmniDTOBasic

getChildrenOmniDTOMap

public java.util.Map<java.lang.String,OmniDTO> getChildrenOmniDTOMap()
returns childrenOmniDTOMap

Specified by:
getChildrenOmniDTOMap in interface OmniDTOBasic

addChildrenOmniDTOToMap

public void addChildrenOmniDTOToMap(java.lang.String key,
                                    OmniDTO returnTO)
adds a childrenOmniDTO to Map

Specified by:
addChildrenOmniDTOToMap in interface OmniDTOBasic

toXML

public java.lang.String toXML()
Returns a XML string representation of the object.

Specified by:
toXML in interface OmniDTOBasic
Returns:
String

getMethodNamesSupportingStoredProcedureProcessorOnly

public java.lang.String getMethodNamesSupportingStoredProcedureProcessorOnly()
Returns method names that are only useful when the underlying processor is a StoredProcedureProcessor.


getMethodNamesSupportingFunctionProcessorOnly

public java.lang.String getMethodNamesSupportingFunctionProcessorOnly()
Returns method names that are only useful when the underlying processor is a FunctionProcessor.


getMethodNamesSupportingJdbcStatementProcessorOnly

public java.lang.String getMethodNamesSupportingJdbcStatementProcessorOnly()
Returns method names that are only useful when the underlying processor is a JdbcStatementProcessor.


toString

public java.lang.String toString()
Returns a string representation of the object.

Specified by:
toString in interface OmniDTOBasic
Overrides:
toString in class java.lang.Object
Returns:
String