jet.formula

Class fResponse

java.lang.Object

jet.connect.DbValue

jet.formula.fResponse

public class fResponse
extends DbValue

Implementing the Response data type of formula

Field Summary

Fields inherited from class jet.connect.DbValue

BIGINT_DESC, bNull, CHAR_DESC, CURRENCY_DESC, DATE_DESC, desc, DOUBLE_DESC, INTEGER_DESC, TIME_DESC

Constructor Summary

Constructors

Constructor and Description
fResponse()
fResponse(DbColDesc dbColDesc)
fResponse(JsonObject job, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerFields)
fResponse(JsonStructure job, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerFields)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a clone of this DbValue variable.
int	compareTo(DbValue v, boolean matchSQL) Compares with the DbValue object.
boolean	equals(DbValue v) Determines if another DbValue object is of equal value as this DbValue Object.
DbChar	errorMessage()
fResponse	get() TODO need a clear return type of get(), not just 'fResponse'
fJsonObject	getBody()
DbChar	getHeaderProperty(DbChar key) Retrieves header property with specified name
void	set(DbValue v) Sets the value with DbValue.
void	set(java.sql.ResultSet rs, int col) Sets the value with the result set value specified by column index.
void	setErrorMessage(java.lang.String msg)
void	setValue(java.lang.String v) Set the value with a string.
void	success(boolean successed)
DbBit	successed()
java.lang.String	toString() Converts the value to string.
java.lang.String	toStringValue()

Methods inherited from class jet.connect.DbValue

compareTo, compareTo, compareTo, equals, getColDesc, getDataTimeZone, getPrecision, getScale, getSqlType, isCurrency, isNull, makeDbValue, set, setColDesc, setfoo, setNull, setValue

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

fResponse

public fResponse()

fResponse

public fResponse(JsonObject job,
                 java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerFields)

fResponse

public fResponse(JsonStructure job,
                 java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerFields)

fResponse

public fResponse(DbColDesc dbColDesc)

Method Detail

getHeaderProperty

public DbChar getHeaderProperty(DbChar key)

Retrieves header property with specified name

Parameters:

key - String, name of the property

Returns:

String, value of the property. NULL if the property with the name doesn't exist.

getBody

public fJsonObject getBody()

Returns:

fJsonStructure, the body of the HTTP response. When the response is a JsonArray, it will be enclosed by '{"":' and '}' to make it a JsonObject.

successed

public DbBit successed()

Returns:

true if the request has been executed successfully false if he request failed by any reason

success

public void success(boolean successed)

errorMessage

public DbChar errorMessage()

Returns:

The brief error message indicates why the request failed

setErrorMessage

public void setErrorMessage(java.lang.String msg)

get

public fResponse get()

TODO need a clear return type of get(), not just 'fResponse'

Returns:

set

public void set(java.sql.ResultSet rs,
                int col)
         throws java.sql.SQLException

Description copied from class: DbValue

Sets the value with the result set value specified by column index.

Specified by:

set in class DbValue

Parameters:

rs - The source value result set.

col - The source value column number in the rs.

Throws:

java.sql.SQLException

set

public void set(DbValue v)

Description copied from class: DbValue

Sets the value with DbValue.

Specified by:

set in class DbValue

clone

public java.lang.Object clone()

Description copied from class: DbValue

Creates a clone of this DbValue variable.

Specified by:

clone in class DbValue

equals

public boolean equals(DbValue v)

Description copied from class: DbValue

Determines if another DbValue object is of equal value as this DbValue Object.

Specified by:

equals in class DbValue

setValue

public void setValue(java.lang.String v)

Description copied from class: DbValue

Set the value with a string.

Specified by:

setValue in class DbValue

compareTo

public int compareTo(DbValue v,
                     boolean matchSQL)

Description copied from class: DbValue

Compares with the DbValue object.

Specified by:

compareTo in class DbValue

Returns:

LESS, EQUAL, GREAT, or NULL.

See Also:

jet.util.DbValueable

toString

public java.lang.String toString()

Description copied from class: DbValue

Converts the value to string.

Specified by:

toString in class DbValue

toStringValue

public java.lang.String toStringValue()

Specified by:

toStringValue in class DbValue

Returns:

a string which will represent the value in the DbValue(null flag and value). When compare StringValue from DbValues, we always assume that: the two DbValues have same DbColDesc. Two StringValue equals means the original DbValue equals. Does NOT transfer the compareTo(DbValue v) method. Only comparable dbValue implements this methods. String coding uses Base64.