RCParameter Class Properties

In this section, the RCParameter class properties are presented in alphabetical order.

Description

Use the Descr property to set or return a string value representing the description for this URL parameter.

This property is read/write.

Example

import PTCS_SRVDEFN:*;

Component PTCS_SRVDEFN:RCServiceDefinition &rcServDefn;
Component PTCS_SRVDEFN:RCParameter &oRCDefnParam;

&rcServDefn = create PTCS_SRVDEFN:RCServiceDefinition("GOOGLE", "ENG");
&oRCDefnParam = &rcServDefn.AppendRCParam("q");
&oRCDefnParam.Descr = "Search terms";

Description

Use the ParameterName property to set or return a string value representing the parameter name for this URL parameter.

This property is read/write.

Example

import PTCS_SRVDEFN:*;

Component PTCS_SRVDEFN:RCServiceDefinition &rcServDefn;
Component PTCS_SRVDEFN:RCParameter &oRCDefnParam;

&rcServDefn = create PTCS_SRVDEFN:RCServiceDefinition("GOOGLE", "ENG");
&oRCDefnParam = &rcServDefn.AppendRCParam("q");
/* Change the parameter name */
&oRCDefnParam.ParameterName = "as_q";
&oRCDefnParam.Descr = "Advanced search terms";

Description

Use the RequiredFlg property to set or return a Y/N string value indicating whether this URL parameter is required. When a URL parameter is designated as required, a value must be mapped to the parameter when the service is configured.

Note: The default value is N.

This property is read/write.

Example

import PTCS_SRVDEFN:*;

Component PTCS_SRVDEFN:RCServiceDefinition &rcServDefn;
Component PTCS_SRVDEFN:RCParameter &oRCDefnParam;

&rcServDefn = create PTCS_SRVDEFN:RCServiceDefinition("GOOGLE", "ENG");
&oRCDefnParam = &rcServDefn.AppendRCParam("q");
&oRCDefnParam.Descr = "Search terms";
&oRCDefnParam.RequiredFlg = "Y"; /* Set Y/N value */
&oRCDefnParam.SeqNum = 1;

Description

Use the SeqNum property to set or return a number value specifying the sequence number for this URL parameter.

This property is read/write.

Example

import PTCS_SRVDEFN:*;

Component PTCS_SRVDEFN:RCServiceDefinition &rcServDefn;
Component PTCS_SRVDEFN:RCParameter &oRCDefnParam;

&rcServDefn = create PTCS_SRVDEFN:RCServiceDefinition("GOOGLE", "ENG");
&oRCDefnParam = &rcServDefn.AppendRCParam("q");
&oRCDefnParam.Descr = "Search terms";
&oRCDefnParam.RequiredFlg = "Y"; /* Set Y/N value */
&oRCDefnParam.SeqNum = 1;