nca_java_set_area_class

Java Object Functions

Sets the area class property for a Java object.

void nca_java_set_area_class( void * ReplyPropList );
ReplyPropList A list of reply properties.

The nca_java_set_area_class function sets the area class property, IXPROP_JAVA_AREA_CLASS (397), for a Java object.

This function is entered in the script when the server creates Java objects that have the property.

The ReplyPropList argument is two-dimensional array of strings . The first string in each dimension is the Java object's name, either the latest value of property IXPROP_TITLE (129) or the object's HandlerId value if no later property was specified for the object. The second string is the value of the IXPROP_JAVA_AREA_CLASS (397) property , sent to or specified by the server. The third string is the event name: the value of property IXPROP_JAVA_AREA_EVENT_NAME (399) that the recorded client application sent. The fourth string is the value that should be supplied. It consists of properties, IXPROP_JAVA_AREA_ARG_NAME (400) and IXPROP_JAVA_AREA_ARG_VALUE (401), separated with a double equality sign (==). If the properties are absent, pass an empty string.

Where the property has multiple values that must be set, use a parameter for the values rather than entering each value in a separate row of JavaClassProp. For example, this definition with multiple values for mGetProperty is invalid for use with nca_java_set_area_class:

char* JavaClassProp[][4] = {
	{ "GRID_BLOCK_GRID_ITEM_0",
		"oracle.apps.jtf.table.SpreadTableWrapper",
		"resourceRequest", "resources==[29]" },
	{ "GRID_BLOCK_GRID_ITEM_0",
		"oracle.apps.jtf.table.SpreadTableWrapper",
		"resourceRequest", "resources==[42]" },
	{ "GRID_BLOCK_GRID_ITEM_0",
		"oracle.apps.jtf.table.SpreadTableWrapper",
		"resourceRequest", "resources==[89]" },
	{ 0, 0, 0, 0 }

To pass multiple values of "resources", specify a parameter in the parameters table, named p_Resources in this example, and set the values. In this example, the values for p_Resources are "resources==[29]", "resources==[42]", and "resources==[89]". Define the parameter as sequential and to be modified each occurrence. Then use this declaration:

char* JavaClassProp[][4] = {
	{ "GRID_BLOCK_GRID_ITEM_0",
		"oracle.apps.jtf.table.SpreadTableWrapper",
		"resourceRequest", "{p_Resources}" },
	{ 0, 0, 0, 0 }

This and other nca_java functions can be sent to the server as a single packet by wrapping the set of nca_java calls with nca_step_begin and nca_step_end functions.

Return Values

Oracle NCA Error Codes

Parameterization

Parameterization is not available for this function.

Example

In this example, the IXPROP_JAVA_AREA_CLASS property of oracle.apps.jtf.table.SpreadTableWrapper is set to resources==[29] for event resourceRequest and IXPROP_JAVA_AREA_CLASS property of oracle.apps.jtf.table.SpreadTableWrapper for event resourceRequest is set to an empty string.

char* JavaClassProp[][4] = {
    { "GRID_BLOCK_GRID_ITEM_0",
        "oracle.apps.jtf.table.SpreadTableWrapper",
        "resourceRequest", "resources==[29] " },
    { "GRID_BLOCK_GRID_ITEM_0",
        "oracle.apps.jtf.table.SpreadTableWrapper",
        "msgRequested",
        "" },
    { 0, 0, 0, 0 }
};
nca_java_set_area_class( JavaClassProp );
nca_connect_server( ... );
The following section of a log file illustrates the above properties:
Server Message Properties: action=1 handlerClassId=0x10F handlerId=223
    property=129 type=0x4000 value="GRID_BLOCK_GRID_ITEM_0"
    property=397 type=0x4000 value="oracle.apps.jtf.table.SpreadTableWrapper"    
Server Terminate Message: #5
Client Message Properties: action=2 handlerClassId=0x10F handlerId=223
    property=398 type=0xE008 value=Message
    Sub Message Properties: action=2 handlerClassId=0x10F handlerId=223
        property=399 type=0x4000 value="resourceRequest"
        property=400 type=0x4000 value="resources"
        property=401 type=0x4000 value="[29]"
Client Message Properties: action=2 handlerClassId=0x10F handlerId=223
    property=398 type=0xE008 value=Message
    Sub Message Properties: action=2 handlerClassId=0x10F handlerId=223
        property=399 type=0x4000 value="msgRequested"