com.konylabs.middleware.dataobject

Class Param

java.lang.Object

com.konylabs.middleware.dataobject.Param

All Implemented Interfaces:

Serializable

public class Param
extends Object
implements Serializable

Param represents a parameter or variable part of Result or Record object. It has parameter name, parameter value along with meta-data like data type, data format etc.

See Also:

Result, Record, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOOLEAN_CONST Constant for "boolean" parameter type.
static String	COLLECTION_CONST Constant for "collection" parameter type.
static String	DOUBLE_CONST Constant for "double" parameter type.
static String	ERR_MSG Constant for errmsg parameter name.
static String	HTTP_STATUS_CODE Constant for httpStatusCode parameter name.
static String	INT_CONST Constant for "int" parameter type.
static String	NUMBER_CONST Constant for "number" parameter type.
static String	OPSTATUS Constant for opstatus parameter name.
static String	STRING_CONST Constant for "string" parameter type.

Constructor Summary

Constructors

Constructor and Description
Param() Creates a Param with default values.
Param(String name, String value) Creates a Param with specified name and value.
Param(String name, String value, String type) Creates a Param with specified name, value and type.
Param(String name, String value, String type, String format, String formatValue) Creates a Param with specified properties.
Param(String name, String value, String type, String format, String formatValue, String accessType) Creates a Param with specified properties.

Method Summary

Modifier and Type	Method and Description
String	getAccessType() Gets the access type of the Param, for example "readonly".
String	getEscapeXMLValue() Gets the escaped (or encoded) value the Param so that it is safe to use it in XML strings.
String	getFormat() Gets the format or sub-type of the Param, for example "Currency".
String	getFormatValue() Gets the format value of the Param, for example "YYYY-MM-DD" for date.
String	getName() Gets the name of the Param.
Object	getObjectValue() Gets the value of the Param.
String	getType() Gets the type of the Param, for example "boolean", or "int", or "collection".
String	getValue() Gets the value of the Param.
boolean	isObjectSet() Gets whether proper object value has been set or not.
void	setAccessType(String accessType) Sets the access type of the Param, for example "readonly".
void	setFormat(String format) Sets the format or sub-type of the Param, for example "Currency".
void	setFormatValue(String formatValue) Sets the format value of the Param, for example "YYYY-MM-DD" for date.
void	setName(String name) Sets the name of the Param.
void	setObjectValue(Object objectValue) Sets the value of the Param as proper object.
void	setType(String type) Sets the type of the Param, for example "boolean", or "int", or "collection".
void	setValue(String value) Sets the value of the Param.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

OPSTATUS

public static final String OPSTATUS

Constant for opstatus parameter name.

Since:

Fabric V8 SP4 (8.4) release.

See Also:

Constant Field Values

ERR_MSG

public static final String ERR_MSG

Constant for errmsg parameter name.

Since:

Fabric V8 SP4 (8.4) release.

See Also:

Constant Field Values

HTTP_STATUS_CODE

public static final String HTTP_STATUS_CODE

Constant for httpStatusCode parameter name.

Since:

Fabric V8 SP4 (8.4) release.

See Also:

Constant Field Values

INT_CONST

public static final String INT_CONST

Constant for "int" parameter type.

Since:

Fabric V8 SP4 (8.4) release.

See Also:

Constant Field Values

STRING_CONST

public static final String STRING_CONST

Constant for "string" parameter type.

Since:

Fabric V8 SP4 (8.4) release.

See Also:

Constant Field Values

NUMBER_CONST

public static final String NUMBER_CONST

Constant for "number" parameter type.

Since:

Fabric V8 SP4 FP2 (8.4.2) release.

See Also:

Constant Field Values

DOUBLE_CONST

public static final String DOUBLE_CONST

Constant for "double" parameter type.

Since:

Fabric V8 SP4 FP2 (8.4.2) release.

See Also:

Constant Field Values

BOOLEAN_CONST

public static final String BOOLEAN_CONST

Constant for "boolean" parameter type.

Since:

Fabric V8 SP4 FP2 (8.4.2) release.

See Also:

Constant Field Values

COLLECTION_CONST

public static final String COLLECTION_CONST

Constant for "collection" parameter type.

Since:

Fabric V8 SP4 FP2 (8.4.2) release.

See Also:

Constant Field Values

Constructor Detail

Param

public Param()

Creates a Param with default values.

Param

public Param(String name,
             String value)

Creates a Param with specified name and value.

Parameters:

name - The name of the Param

value - The value of the Param

Since:

MobileFabric 7.3.2

Param

public Param(String name,
             String value,
             String type)

Creates a Param with specified name, value and type.

Parameters:

name - The name of the Param

value - The value of the Param

type - The type of the Param

Param

public Param(String name,
             String value,
             String type,
             String format,
             String formatValue)

Creates a Param with specified properties.

Parameters:

name - The name of the Param

value - The value of the Param

type - The type of the Param

format - The format of the Param

formatValue - The format value of the Param

Param

public Param(String name,
             String value,
             String type,
             String format,
             String formatValue,
             String accessType)

Creates a Param with specified properties.

Parameters:

name - The name of the Param

value - The value of the Param

type - The type of the Param

format - The format of the Param

formatValue - The format value of the Param

accessType - The access type of the Param

Method Detail

getName

public String getName()

Gets the name of the Param.

Returns:

The name of the Param

setName

public void setName(String name)

Sets the name of the Param.

Parameters:

name - The name to set

getValue

public String getValue()

Gets the value of the Param.

Returns:

The value of the Param

setValue

public void setValue(String value)

Sets the value of the Param.

Parameters:

value - The value to set

getType

public String getType()

Gets the type of the Param, for example "boolean", or "int", or "collection".

Returns:

The type of the Param

setType

public void setType(String type)

Sets the type of the Param, for example "boolean", or "int", or "collection".

Parameters:

type - The type to set

getFormat

public String getFormat()

Gets the format or sub-type of the Param, for example "Currency". This may or may not be supported by the specific connector used for the back-end service.

Returns:

The format of the Param

setFormat

public void setFormat(String format)

Sets the format or sub-type of the Param, for example "Currency". This may or may not be supported by the specific connector used for the back-end service.

Parameters:

format - The format to set

getFormatValue

public String getFormatValue()

Gets the format value of the Param, for example "YYYY-MM-DD" for date. This may or may not be supported by the specific connector used for the back-end service.

Returns:

The format value of the Param

setFormatValue

public void setFormatValue(String formatValue)

Sets the format value of the Param, for example "YYYY-MM-DD" for date. This may or may not be supported by the specific connector used for the back-end service.

Parameters:

formatValue - The format value to set

getAccessType

public String getAccessType()

Gets the access type of the Param, for example "readonly". This may or may not be supported by the specific connector used for the back-end service.

Returns:

The access type of the Param

setAccessType

public void setAccessType(String accessType)

Sets the access type of the Param, for example "readonly". This may or may not be supported by the specific connector used for the back-end service.

Parameters:

accessType - The access type to set

getEscapeXMLValue

public String getEscapeXMLValue()

Gets the escaped (or encoded) value the Param so that it is safe to use it in XML strings.

Returns:

The encoded value of the Param

isObjectSet

public boolean isObjectSet()

Gets whether proper object value has been set or not.

Returns:

True if proper object value has been set, false if string value has been set.

getObjectValue

public Object getObjectValue()

Gets the value of the Param. This returns the proper object if that has been set else the string value.

Returns:

The value of the Param

setObjectValue

public void setObjectValue(Object objectValue)

Sets the value of the Param as proper object.

Parameters:

objectValue - The value of the Param as object

toString

public String toString()

Overrides:

toString in class Object