public interface LegacyJavaAppserverApi
Modifier and Type | Field and Description |
---|---|
static int |
INPUT
Value for INPUT mode.
|
static int |
INPUT_OUTPUT
Value for INPUT-OUTPUT mode.
|
static int |
OUTPUT
Value for OUTPUT mode.
|
static int |
TYPE_BLOB
Value for
blob type. |
static int |
TYPE_CHARACTER
Value for
character type. |
static int |
TYPE_CLOB
Value for
clob type. |
static int |
TYPE_DATASET
Value for
DataSetContainer type. |
static int |
TYPE_DATASET_HANDLE
Value for
DataSetContainer type. |
static int |
TYPE_DATE
Value for
date type. |
static int |
TYPE_DATETIME
Value for
datetime type. |
static int |
TYPE_DATETIMETZ
Value for
datetimetz type. |
static int |
TYPE_DECIMAL
Value for
decimal type. |
static int |
TYPE_HANDLE
Value for
handle type. |
static int |
TYPE_INT64
Value for
int64 type. |
static int |
TYPE_INTEGER
Value for
integer type. |
static int |
TYPE_LOGICAL
Value for
logical type. |
static int |
TYPE_LONGCHAR
Value for
longchar type. |
static int |
TYPE_MEMPTR
Value for
memptr type. |
static int |
TYPE_RAW
Value for
raw type. |
static int |
TYPE_RECID
Value for
recid type. |
static int |
TYPE_ROWID
Value for
rowid type. |
static int |
TYPE_TABLE_HANDLE
Value for
TempTableResultSet type. |
static int |
TYPE_UNKNOWN
Value for
unknown type. |
Modifier and Type | Method and Description |
---|---|
void |
addDataObject(commonj.sdo.DataGraph graph,
commonj.sdo.DataObject row)
Add the specified row to the graph.
|
void |
addDataObject(commonj.sdo.DataObject tableMetaData,
commonj.sdo.DataObject row)
Add the specified row to the graph.
|
void |
addRelation(commonj.sdo.DataObject metaData,
java.lang.String name,
java.lang.String parentBuffer,
java.lang.String childBuffer,
java.lang.String whereString,
boolean active,
boolean parentId,
java.lang.String pairs,
boolean fkeyHidden,
boolean recursive,
boolean nested,
boolean reposition)
Add a relation to the graph's metadata.
|
void |
addTableMetaData(commonj.sdo.DataObject metaData,
commonj.sdo.DataObject table)
Add the specified table metadata to the graph.
|
void |
beginLogging(java.lang.Object changeSummary)
Begin the logging for changes in this object.
|
default int |
blob()
Get the type for a BLOB.
|
default int |
character()
Get the type for a CHARACTER.
|
default int |
clob()
Get the type for a CLOB.
|
commonj.sdo.DataGraph |
createDataGraph()
Create a new graph to hold a dataset.
|
commonj.sdo.DataGraph |
createDataGraph(java.lang.Object metadata)
Create a new metadata object to hold the table details.
|
commonj.sdo.DataObject |
createDataObject(commonj.sdo.DataGraph graph,
java.lang.String table)
Create a new row for the specified table.
|
commonj.sdo.DataObject |
createDataObject(commonj.sdo.DataObject tableMetaData)
Create a new row for the specified table.
|
commonj.sdo.DataObject |
createGraphMetaData(java.lang.String name)
Create a metadata object with the specified name.
|
java.lang.Object |
createMemptr(byte[] value)
Create a memptr corresponding instance.
|
commonj.sdo.DataObject |
createObjectMetaData(java.lang.String name,
int numFields,
boolean b4img,
int numIndexes,
java.lang.String indexes,
java.lang.String xmlns,
java.lang.String xmlPrefix)
Deprecated.
|
commonj.sdo.DataObject |
createObjectMetaData(java.lang.String name,
int numFields,
boolean b4img,
int numIndexes,
java.lang.String indexes,
java.lang.String xmlns,
java.lang.String xmlPrefix,
java.lang.String xmlNodeName,
java.lang.String errorString)
Create an object with a table metadata.
|
default int |
dataset()
Get the type for a DATASET.
|
default int |
datasetHandle()
Get the type for a DATASET-HANDLE.
|
default int |
date()
Get the type for a DATE.
|
default int |
datetime()
Get the type for a DATETIME.
|
default int |
datetimetz()
Get the type for a DATETIME-TZ.
|
default int |
decimal()
Get the type for a DECIMAL.
|
void |
endLogging(java.lang.Object changeSummary)
End the logging for changes in this object.
|
java.lang.String |
getArgumentModes(LegacyJavaAppserverParameter[] paramArray)
Get a string representation of the argument's modes.
|
java.lang.Object[] |
getArguments(LegacyJavaAppserverParameter[] paramArray)
Resolve the arguments from the given parameter array.
|
byte[] |
getBytes(java.lang.Object outputParameter)
Get the bytes from the given output parameter, which is a memptr compatible instance.
|
java.util.List<commonj.sdo.DataObject> |
getChangedDataObjects(java.lang.Object changeSummary)
Get all the changed objects in this change summary.
|
commonj.sdo.DataGraph |
getChanges(java.lang.Object changeSummary)
Get the changes in this change summary, as a graph.
|
java.lang.Object |
getChangeSummary(commonj.sdo.DataGraph graph)
Get the change summary object for this graph.
|
java.util.List<commonj.sdo.DataObject> |
getChildRows(commonj.sdo.DataObject row,
java.lang.String relation)
Get the child rows for this record.
|
AppServerHelper |
getConnection(BootstrapConfig config,
java.lang.String account,
java.lang.String appServerName,
boolean sessionFree,
java.lang.String user,
java.lang.String pwd,
java.lang.String serverInfo)
Create a new FWd connection with the specified configuration.
|
java.lang.String |
getDataGraphName(commonj.sdo.DataObject metadata)
Get the graph name from the specified metadata, of type
graphmetadata . |
java.util.List<commonj.sdo.DataObject> |
getDataObjects(commonj.sdo.DataGraph graph,
int idx)
Get all the records for the table on the specified index, in the graph metadata.
|
java.util.List<commonj.sdo.DataObject> |
getDataObjects(commonj.sdo.DataGraph graph,
java.lang.String table)
Get all the records for the table with the specified name, in this graph.
|
java.util.List<commonj.sdo.DataObject> |
getDataObjects(commonj.sdo.DataObject tableMeta)
Get all the records for the specified table.
|
int |
getFieldCount(commonj.sdo.DataObject row)
Get the number of fields for a given row.
|
java.lang.String |
getFieldName(commonj.sdo.DataObject row,
int i)
Get the name of the field on the given index in the metadata.
|
int |
getFieldType(commonj.sdo.DataObject row,
int i)
Get the type of the field on the given index in the metadata.
|
java.lang.String |
getGraphName(commonj.sdo.DataObject tableMetadata)
Get the data graph name for the given table metadata.
|
java.util.GregorianCalendar |
getGregorianCalendar(commonj.sdo.DataObject row,
int idx)
Get the row's property on the given index as a
GregorianCalendar . |
java.util.GregorianCalendar |
getGregorianCalendar(commonj.sdo.DataObject row,
java.lang.String name)
Get the row's property as a
GregorianCalendar . |
LegacyJavaAppserverParameter |
getJavaParameter(int mode,
int type,
java.lang.Object value,
java.lang.Object metadata)
Configure a
LegacyJavaAppserverParameter with the given details. |
commonj.sdo.DataObject |
getMetaData(commonj.sdo.DataGraph graph)
Get the metadata object for this graph, from the
metadata property of the root
object. |
int |
getNumTables(commonj.sdo.DataGraph graph)
Get the number of tables for a graph.
|
int |
getNumTables(commonj.sdo.DataObject metaData)
Get the number of tables for a graph metadata.
|
java.lang.Object |
getOutputParameter(LegacyJavaAppserverParameter param)
Determine the output parameter value.
|
java.lang.Object |
getOutputParameter(LegacyJavaAppserverParameter[] paramArray,
int i)
Determine the output parameter value on the given index.
|
int |
getTableFieldType(commonj.sdo.DataObject tableMetadata,
java.lang.String fieldName)
Get the field type.
|
java.util.List<commonj.sdo.DataObject> |
getTableMetaData(commonj.sdo.DataGraph graph)
Get the metadata list for all tables.
|
commonj.sdo.DataObject |
getTableMetaData(commonj.sdo.DataGraph graph,
java.lang.String table)
Get the metadata for the specified table.
|
commonj.sdo.DataObject |
getTableMetaData(commonj.sdo.DataObject metaData,
int i)
Get the metadata for the table registered on the given index in the graph.
|
java.lang.String |
getTableName(commonj.sdo.DataObject value)
Get the table name for a given row or table metadata.
|
java.lang.String[] |
getTableNames(commonj.sdo.DataGraph graph)
Get all table names from the given graph.
|
default int |
handle()
Get the type for a HANDLE.
|
default int |
input()
Get the value for INPUT mode.
|
default int |
inputOutput()
Get the value for INPUT-OUTPUT mode.
|
default int |
int64()
Get the type for a INT64.
|
default int |
integer()
Get the type for a INTEGER.
|
boolean |
isCreated(java.lang.Object changeSummary,
commonj.sdo.DataObject object)
Check if the given object is newly created.
|
boolean |
isDeleted(java.lang.Object changeSummary,
commonj.sdo.DataObject object)
Check if the given object has been deleted.
|
boolean |
isMemptr(java.lang.Object outputParameter)
Check if the given parameter is a memptr.
|
boolean |
isTableField(commonj.sdo.DataObject tableMetadata,
java.lang.String fieldName)
Check if this table has a field defined with that name.
|
default int |
logical()
Get the type for a LOGICAL.
|
default int |
longchar()
Get the type for a LONGCHAR.
|
default int |
memptr()
Get the type for a MEMPTR.
|
default int |
output()
Get the value for OUTPUT mode.
|
void |
postProcessArguments(java.lang.Object paramArray,
java.lang.Object[] args)
Postprocess these arguments - this includes copying state back to the
LegacyJavaAppserverParameter instance, for OUTPUT parameters. |
default int |
raw()
Get the type for a RAW.
|
default int |
recid()
Get the type for a RECID.
|
default int |
rowid()
Get the type for a ROWID.
|
java.util.List<commonj.sdo.DataObject> |
selectRows(commonj.sdo.DataObject tableMetadata,
java.lang.String[] fields,
java.lang.Object[] values)
Retrieve all rows which have an exact match for the specified fields.
|
void |
setFieldMetaData(commonj.sdo.DataObject metaData,
int idx,
java.lang.String name,
int extent,
int type,
int order,
int xmlMapping)
Add a new new field with the specified configuration.
|
void |
setGregorianCalendar(commonj.sdo.DataObject row,
int idx,
java.util.GregorianCalendar date)
Set the field's property on the given index from the
GregorianCalendar instance. |
default int |
tableHandle()
Get the type for a TABLE-HANDLE.
|
default int |
unknown()
Get the type for a UNKNOWN.
|
static final int INPUT
static final int OUTPUT
static final int INPUT_OUTPUT
static final int TYPE_HANDLE
handle
type.static final int TYPE_INTEGER
integer
type.static final int TYPE_INT64
int64
type.static final int TYPE_DECIMAL
decimal
type.static final int TYPE_MEMPTR
memptr
type.static final int TYPE_BLOB
blob
type.static final int TYPE_CLOB
clob
type.static final int TYPE_CHARACTER
character
type.static final int TYPE_LONGCHAR
longchar
type.static final int TYPE_LOGICAL
logical
type.static final int TYPE_DATE
date
type.static final int TYPE_DATETIME
datetime
type.static final int TYPE_DATETIMETZ
datetimetz
type.static final int TYPE_RECID
recid
type.static final int TYPE_RAW
raw
type.static final int TYPE_ROWID
rowid
type.static final int TYPE_UNKNOWN
unknown
type.static final int TYPE_DATASET
DataSetContainer
type.static final int TYPE_DATASET_HANDLE
DataSetContainer
type.static final int TYPE_TABLE_HANDLE
TempTableResultSet
type.default int input()
INPUT
.default int output()
OUTPUT
.default int inputOutput()
INPUT_OUTPUT
.default int handle()
TYPE_HANDLE
.default int integer()
TYPE_INTEGER
.default int int64()
TYPE_INT64
.default int decimal()
TYPE_DECIMAL
.default int memptr()
TYPE_MEMPTR
.default int blob()
TYPE_BLOB
.default int clob()
TYPE_CLOB
.default int raw()
TYPE_RAW
.default int rowid()
TYPE_ROWID
.default int recid()
TYPE_RECID
.default int unknown()
TYPE_UNKNOWN
.default int character()
TYPE_CHARACTER
.default int longchar()
TYPE_LONGCHAR
.default int logical()
TYPE_LOGICAL
.default int date()
TYPE_DATE
.default int datetime()
TYPE_DATETIME
.default int datetimetz()
TYPE_DATETIMETZ
.default int dataset()
TYPE_DATASET
.default int datasetHandle()
TYPE_DATASET_HANDLE
.default int tableHandle()
TYPE_TABLE_HANDLE
.java.util.List<commonj.sdo.DataObject> getDataObjects(commonj.sdo.DataGraph graph, int idx)
graph
- The graph.idx
- The table index.java.util.List<commonj.sdo.DataObject> getDataObjects(commonj.sdo.DataGraph graph, java.lang.String table)
graph
- The graph.table
- The table name.java.util.List<commonj.sdo.DataObject> getDataObjects(commonj.sdo.DataObject tableMeta)
tableMeta
- The table metadata.java.util.List<commonj.sdo.DataObject> getChildRows(commonj.sdo.DataObject row, java.lang.String relation)
row
- The row.relation
- The child relation.java.util.GregorianCalendar getGregorianCalendar(commonj.sdo.DataObject row, int idx)
GregorianCalendar
.row
- The row.idx
- The property index.void setGregorianCalendar(commonj.sdo.DataObject row, int idx, java.util.GregorianCalendar date)
GregorianCalendar
instance.row
- The row.idx
- The property index.date
- The property's value.java.util.GregorianCalendar getGregorianCalendar(commonj.sdo.DataObject row, java.lang.String name)
GregorianCalendar
.row
- The row.name
- The property name.commonj.sdo.DataGraph createDataGraph()
graph
node.commonj.sdo.DataGraph createDataGraph(java.lang.Object metadata)
metadata
- The root graph node.commonj.sdo.DataObject createDataObject(commonj.sdo.DataGraph graph, java.lang.String table)
addDataObject(DataGraph, DataObject)
to add it.graph
- The graph.table
- The table name.commonj.sdo.DataObject createDataObject(commonj.sdo.DataObject tableMetaData)
addDataObject(DataObject, DataObject)
to add it.tableMetaData
- The table metadata.void addDataObject(commonj.sdo.DataGraph graph, commonj.sdo.DataObject row)
graph
- The field's graph.row
- The row to add to the table.void addDataObject(commonj.sdo.DataObject tableMetaData, commonj.sdo.DataObject row)
tableMetaData
- The table metadata.row
- The row to add to the table.java.lang.String getTableName(commonj.sdo.DataObject value)
value
- The table row or table metadata.java.lang.String getGraphName(commonj.sdo.DataObject tableMetadata)
tableMetadata
- The table metadata.null
if the table is not part of a graph.int getFieldCount(commonj.sdo.DataObject row)
row
- The table row.java.lang.String getFieldName(commonj.sdo.DataObject row, int i)
row
- The table row. Must be attached to a table.i
- The field index.int getFieldType(commonj.sdo.DataObject row, int i)
row
- The table row. Must be attached to a table.i
- The field index.boolean isTableField(commonj.sdo.DataObject tableMetadata, java.lang.String fieldName)
tableMetadata
- The table metadata.fieldName
- The field name.true
if there is a field defined with this name.int getTableFieldType(commonj.sdo.DataObject tableMetadata, java.lang.String fieldName)
tableMetadata
- The table metadata.fieldName
- The field name.java.lang.String[] getTableNames(commonj.sdo.DataGraph graph)
graph
- The graph.int getNumTables(commonj.sdo.DataGraph graph)
graph
- The graph.int getNumTables(commonj.sdo.DataObject metaData)
metaData
- The graph metadata.commonj.sdo.DataObject getMetaData(commonj.sdo.DataGraph graph)
metadata
property of the root
object.graph
- The graph.commonj.sdo.DataObject getTableMetaData(commonj.sdo.DataObject metaData, int i)
metaData
- The graph metadata.i
- The table index.commonj.sdo.DataObject getTableMetaData(commonj.sdo.DataGraph graph, java.lang.String table)
graph
- The graph.table
- The table name.null
if the table is not part of this graph.java.util.List<commonj.sdo.DataObject> getTableMetaData(commonj.sdo.DataGraph graph)
graph
- The graph.@Deprecated commonj.sdo.DataObject createObjectMetaData(java.lang.String name, int numFields, boolean b4img, int numIndexes, java.lang.String indexes, java.lang.String xmlns, java.lang.String xmlPrefix)
tablemetadata
type and is not
attached to the graph.name
- The table's name.numFields
- The number of fields.b4img
- Flag indicating if the table has a BEFORE-IMAGE.numIndexes
- The number of indexes.indexes
- The index specification.xmlns
- The XML namespace.xmlPrefix
- The XML prefix.commonj.sdo.DataObject createObjectMetaData(java.lang.String name, int numFields, boolean b4img, int numIndexes, java.lang.String indexes, java.lang.String xmlns, java.lang.String xmlPrefix, java.lang.String xmlNodeName, java.lang.String errorString)
tablemetadata
type and is not
attached to the graph.name
- The table's name.numFields
- The number of fields.b4img
- Flag indicating if the table has a BEFORE-IMAGE.numIndexes
- The number of indexes.indexes
- The index specification.xmlns
- The XML namespace.xmlPrefix
- The XML prefix.xmlNodeName
- The XML node name.errorString
- The table's ERROR-STRING attribute.void setFieldMetaData(commonj.sdo.DataObject metaData, int idx, java.lang.String name, int extent, int type, int order, int xmlMapping)
metaData
- The table metadata, of type tablemetadata
. The field will be added
to the fields
property.idx
- The field's index in the metadata.name
- The field's name.extent
- The field's extent.type
- The legacy type (numeric value based on LegacyJavaAppserver
constants.order
- The field's order.xmlMapping
- The field's mapping.commonj.sdo.DataObject createGraphMetaData(java.lang.String name)
name
- The graph name.createDataGraph(Object)
.void addTableMetaData(commonj.sdo.DataObject metaData, commonj.sdo.DataObject table)
metaData
- The graph metadata.table
- The table metadata.java.lang.String getDataGraphName(commonj.sdo.DataObject metadata)
graphmetadata
.metadata
- The metadata.LegacyJavaAppserverParameter getJavaParameter(int mode, int type, java.lang.Object value, java.lang.Object metadata)
LegacyJavaAppserverParameter
with the given details.mode
- The parameter mode.type
- The parameter type.value
- The parameter value.metadata
- The parameter metadata (in case of DataSet).java.lang.Object getOutputParameter(LegacyJavaAppserverParameter param)
param
- The parameter as received from the remote side.java.lang.Object getOutputParameter(LegacyJavaAppserverParameter[] paramArray, int i)
paramArray
- The parameter array.i
- The parameter's index.java.lang.String getArgumentModes(LegacyJavaAppserverParameter[] paramArray)
paramArray
- The parameter array.java.lang.Object[] getArguments(LegacyJavaAppserverParameter[] paramArray)
paramArray
- The parameter array.java.lang.Object createMemptr(byte[] value)
value
- The bytes.boolean isMemptr(java.lang.Object outputParameter)
outputParameter
- The parameter.byte[] getBytes(java.lang.Object outputParameter)
outputParameter
- The output parameter.AppServerHelper getConnection(BootstrapConfig config, java.lang.String account, java.lang.String appServerName, boolean sessionFree, java.lang.String user, java.lang.String pwd, java.lang.String serverInfo) throws NumberedException
config
- The configuration for the FWD server connection.account
- The FWD account to authenticate on the remote side.appServerName
- The name of the appserver to which the connection will be established.sessionFree
- true
to indicate a session-free operating mode, false
to indicate a session-managed operating mode.user
- The username passed to the appserver's connect procedure.pwd
- The password passed to the appserver's connect procedure.serverInfo
- The info passed to the appserver's connect procedure.NumberedException
- If there are connection problems.void postProcessArguments(java.lang.Object paramArray, java.lang.Object[] args)
LegacyJavaAppserverParameter
instance, for OUTPUT parameters.paramArray
- The parameter array.args
- The returned arguments.commonj.sdo.DataGraph getChanges(java.lang.Object changeSummary)
changeSummary
- The change summary.void endLogging(java.lang.Object changeSummary)
changeSummary
- The change summary.void beginLogging(java.lang.Object changeSummary)
changeSummary
- The change summary.java.lang.Object getChangeSummary(commonj.sdo.DataGraph graph)
graph
- The graph.boolean isDeleted(java.lang.Object changeSummary, commonj.sdo.DataObject object)
changeSummary
- The change summary.object
- The object.boolean isCreated(java.lang.Object changeSummary, commonj.sdo.DataObject object)
changeSummary
- The change summary.object
- The object.java.util.List<commonj.sdo.DataObject> getChangedDataObjects(java.lang.Object changeSummary)
changeSummary
- The change summary.java.util.List<commonj.sdo.DataObject> selectRows(commonj.sdo.DataObject tableMetadata, java.lang.String[] fields, java.lang.Object[] values)
tableMetadata
- The table metadata.fields
- The field list.values
- The values to be matched.void addRelation(commonj.sdo.DataObject metaData, java.lang.String name, java.lang.String parentBuffer, java.lang.String childBuffer, java.lang.String whereString, boolean active, boolean parentId, java.lang.String pairs, boolean fkeyHidden, boolean recursive, boolean nested, boolean reposition)
metaData
- The graph metadata.name
- The relation name.parentBuffer
- The parent buffer.childBuffer
- The child buffer.whereString
- The where string.active
- Flag indicating if this relation is active.parentId
- Flag indicating if parent-id is used.pairs
- The field pairs, in parent, child
format.fkeyHidden
- Flag indicating if fkey-hidden is used.recursive
- Flag indicating if recursive is used.nested
- Flag indicating if nested is used.reposition
- Flag indicating if reposition is used.