oracle.apps.fnd.applcore.oaext.osn.publicutil.converter
Class OsnConversionContext

java.lang.Object
  oracle.apps.fnd.applcore.oaext.osn.publicutil.converter.OsnConversionContext

public final class OsnConversionContext
extends java.lang.Object

A bean that is used to pass additional contextual information into the conversion routine. It will contain values such as the name of the attribute being converted, the row that the value came from and the intended OSN gadget type.

Since:

11.1.1.7.3

Version:

$Header: atgpf/applcore/applications/Common/Model/src/oracle/apps/fnd/applcore/oaext/osn/publicutil/converter/OsnConversionContext.java /st_atgpf_11.1.1.7.3/1 2013/12/06 13:45:05 pacross Exp $

Field Summary

static java.lang.String	GADGET_BOOLEAN Contanst for OSN Gadget Type: Boolean.
static java.lang.String	GADGET_CURRENCY Contanst for OSN Gadget Type: Currency.
static java.lang.String	GADGET_DATE Contanst for OSN Gadget Type: Date.
static java.lang.String	GADGET_DOUBLE Contanst for OSN Gadget Type: Double.
static java.lang.String	GADGET_INTEGER Contanst for OSN Gadget Type: Date.
static java.lang.String	GADGET_PERCENT Contanst for OSN Gadget Type: Percent.
static java.lang.String	GADGET_PERSON Contanst for OSN Gadget Type: Person.
static java.lang.String	GADGET_STRING Contanst for OSN Gadget Type: String.
static java.lang.String	GADGET_UNKNOWN Contanst for OSN Gadget Type: Unknown.
static java.lang.String	GADGET_URL Contanst for OSN Gadget Type: URL.

Constructor Summary

OsnConversionContext(java.lang.String attributeName, java.lang.String gadgetType, oracle.jbo.Row row)
Constructor for the conversion context.

Method Summary

oracle.jbo.AttributeDef	getAttributeDef() Finds the definition of the named attribute.
int	getAttributeIndex() Finds the index (0-based) of the named attribute.
java.lang.String	getAttributeName() Gets the attribute name that will be converted.
java.lang.String	getGadgetType() Gets the intended gadget type that the OSN server is expected for the attribute.
oracle.jbo.Row	getRow() Gets the row containing the attribute value to be converted.
static boolean	isGadgetType(java.lang.String gadgetType) Test to see if the gadgetType is one of the GADGET_* constants.
void	setAttributeName(java.lang.String attributeName) Sets the attribute name that will be converted.
void	setGadgetType(java.lang.String gadgetType) Sets the intended gadget type that the OSN server is expected for the attribute.
void	setRow(oracle.jbo.Row row) Sets the row containing the attribute value to be converted.

Methods inherited from class java.lang.Object

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

Field Detail

GADGET_STRING

public static final java.lang.String GADGET_STRING

Contanst for OSN Gadget Type: String.

See Also:

Constant Field Values

GADGET_BOOLEAN

public static final java.lang.String GADGET_BOOLEAN

Contanst for OSN Gadget Type: Boolean.

See Also:

Constant Field Values

GADGET_URL

public static final java.lang.String GADGET_URL

Contanst for OSN Gadget Type: URL.

See Also:

Constant Field Values

GADGET_PERSON

public static final java.lang.String GADGET_PERSON

Contanst for OSN Gadget Type: Person.

See Also:

Constant Field Values

GADGET_INTEGER

public static final java.lang.String GADGET_INTEGER

Contanst for OSN Gadget Type: Date.

See Also:

Constant Field Values

GADGET_DOUBLE

public static final java.lang.String GADGET_DOUBLE

Contanst for OSN Gadget Type: Double.

See Also:

Constant Field Values

GADGET_PERCENT

public static final java.lang.String GADGET_PERCENT

Contanst for OSN Gadget Type: Percent.

See Also:

Constant Field Values

GADGET_CURRENCY

public static final java.lang.String GADGET_CURRENCY

Contanst for OSN Gadget Type: Currency.

See Also:

Constant Field Values

GADGET_DATE

public static final java.lang.String GADGET_DATE

Contanst for OSN Gadget Type: Date.

See Also:

Constant Field Values

GADGET_UNKNOWN

public static final java.lang.String GADGET_UNKNOWN

Contanst for OSN Gadget Type: Unknown.

See Also:

Constant Field Values

Constructor Detail

OsnConversionContext

public OsnConversionContext(java.lang.String attributeName,
                            java.lang.String gadgetType,
                            oracle.jbo.Row row)

Constructor for the conversion context.

Parameters:

attributeName - the name of the attribute being converted.

gadgetType - gadget type configured for the attribute being sent to OSN.

row - the data row being send to OSN.

Method Detail

setAttributeName

public final void setAttributeName(java.lang.String attributeName)

Sets the attribute name that will be converted.

Parameters:

attributeName - the name of the attribute being converted.

getAttributeName

public final java.lang.String getAttributeName()

Gets the attribute name that will be converted.

Returns:

the name of the attribute being converted.

setGadgetType

public final void setGadgetType(java.lang.String gadgetType)

Sets the intended gadget type that the OSN server is expected for the attribute. The gadget type value should be one of the GADGET_* constants.

Parameters:

gadgetType - gadget type configured for the attribute being sent to OSN.

getGadgetType

public final java.lang.String getGadgetType()

Gets the intended gadget type that the OSN server is expected for the attribute. The gadget type value should be one of the GADGET_* constants.

Returns:

gadget type configured for the attribute being sent to OSN.

setRow

public final void setRow(oracle.jbo.Row row)

Sets the row containing the attribute value to be converted.

Parameters:

row - the data row being send to OSN.

getRow

public final oracle.jbo.Row getRow()

Gets the row containing the attribute value to be converted.

Returns:

the data row being send to OSN.

getAttributeIndex

public final int getAttributeIndex()

Finds the index (0-based) of the named attribute.

Returns:

an integer representing the index of the attribute. If the named attribute is not found, it returns -1.

getAttributeDef

public final oracle.jbo.AttributeDef getAttributeDef()

Finds the definition of the named attribute.

Returns:

the definition of the attribute. If the named attribute is not found, it returns null.

isGadgetType

public static boolean isGadgetType(java.lang.String gadgetType)

Test to see if the gadgetType is one of the GADGET_* constants.

Parameters:

gadgetType - the gadget type to test.

Returns:

true if gadgetType equals GADGET_*.