NationalImParameter Data Type

Java class for NationalImParameter complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="NationalImParameter">
   <complexContent>
     <restriction base=" http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="name">
           <simpleType>
             <restriction base=" http://www.w3.org/2001/XMLSchema}string">
               <maxLength value="800"/>
             </restriction>
           </simpleType>
         </element>
         <element name="value" minOccurs="0">
           <simpleType>
             <restriction base=" http://www.w3.org/2001/XMLSchema}string">
               <maxLength value="50000"/>
             </restriction>
           </simpleType>
         </element>
         <element name="type" minOccurs="0">
           <simpleType>
             <restriction base=" http://www.w3.org/2001/XMLSchema}string">
               <maxLength value="100"/>
             </restriction>
           </simpleType>
         </element>
         <element name="valid_values" minOccurs="0">
           <simpleType>
             <restriction base=" http://www.w3.org/2001/XMLSchema}string">
               <maxLength value="150000"/>
             </restriction>
           </simpleType>
         </element>
         <element name="min_length" minOccurs="0">
           <simpleType>
             <restriction base=" http://www.w3.org/2001/XMLSchema}int">
               <totalDigits value="5"/>
             </restriction>
           </simpleType>
         </element>
         <element name="max_length" minOccurs="0">
           <simpleType>
             <restriction base=" http://www.w3.org/2001/XMLSchema}int">
               <totalDigits value="5"/>
             </restriction>
           </simpleType>
         </element>
         <element name="format" minOccurs="0">
           <simpleType>
             <restriction base=" http://www.w3.org/2001/XMLSchema}string">
               <maxLength value="30"/>
             </restriction>
           </simpleType>
         </element>
         <element name="mandatory_conditional_param_id" type=" http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="mandatory_conditional_value" type=" http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="nested_conditional_param_id" type=" http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="nested_conditional_value" type=" http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="scope" type=" http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="conditional_expression" minOccurs="0">
           <simpleType>
             <restriction base=" http://www.w3.org/2001/XMLSchema}string">
               <maxLength value="50000"/>
             </restriction>
           </simpleType>
         </element>
         <element name="is_hidden" type=" http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="description" minOccurs="0">
           <simpleType>
             <restriction base=" http://www.w3.org/2001/XMLSchema}string">
               <maxLength value="4000"/>
             </restriction>
           </simpleType>
         </element>
       </sequence>
       <attribute name="id" type=" http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="mandatory" type=" http://www.w3.org/2001/XMLSchema}anySimpleType" />
     </restriction>
   </complexContent>
 </complexType>
 

Namespace
(Default)
Properties
name data type type namespace min/max occurs constraints description
id long attribute 0/1   Technical (PCS specific) identifier for the im parameter.
mandatory anySimpleType attribute 0/1   Indicates whether the im parameter is a mandatory input for the Applicants.
name string element 1/1 required Name of the national im parameter, entered by Applicant user. List of valid entries can be retrieved through getImParameters operation.
value string element 0/1   Value of the national im parameter, entered by Applicant user. List of valid entries can be retrieved through getImParameters operation.
type string element 0/1   Type of the national im parameter, not entered by the user. List of valid entries can be retrieved through getImParameters operation.
valid_values string element 0/1   Valid defined values of the national im parameter, not entered by the user. List of valid entries can be retrieved through getImParameters operation.
min_length int element 0/1   Min length of the national im parameter, not entered by the user. Min length can be retrieved through getImParameters operation.
max_length int element 0/1   Max length of the national im parameter, not entered by the user. Max length can be retrieved through getImParameters operation.
format string element 0/1   Format of the national IM parameter, not entered by the user. Format can be retrieved through getImParameters operation.
mandatory_conditional_param_id long element 0/1   Used for mandatory conditional parameters. This value defines the depended upon parameter.
mandatory_conditional_value string element 0/1   Used for mandatory conditional parameters. This value defines for which value(s) of the depended upon parameter current national IM parameter is optional
nested_conditional_param_id long element 0/1   Used for nested conditional parameters. This value defines the depended upon parameter.
nested_conditional_value string element 0/1   Used for nested conditional parameters. This value defines for which value(s) of the depended upon parameter current national IM parameter is enabled for input.
scope string element 0/1   Scope of the national IM parameter (path-section-level or dossier-level).
conditional_expression string element 0/1   Condition expression contains the parent types and their values, not entered by the user. Currently one IM parameter can depend on other IM parameter or dossier Train Type. There can be more than one parent parameter in the relationship and the operator used to test the condition is "AND". Condition expression can be retrieved through getImParameters operation.
is_hidden boolean element 0/1   Indicates if IM parameter is hidden. Description can be retrieved through getImParameters operation.
description string element 0/1   Description for the IM parameter, note entered by the user. Description can be retrieved through getImParameters operation.

Example

<n----- id="..." mandatory="...">
  <name>...</name>
  <value>...</value>
  <type>...</type>
  <valid_values>...</valid_values>
  <min_length>...</min_length>
  <max_length>...</max_length>
  <format>...</format>
  <mandatory_conditional_param_id>...</mandatory_conditional_param_id>
  <mandatory_conditional_value>...</mandatory_conditional_value>
  <nested_conditional_param_id>...</nested_conditional_param_id>
  <nested_conditional_value>...</nested_conditional_value>
  <scope>...</scope>
  <conditional_expression>...</conditional_expression>
  <is_hidden>...</is_hidden>
  <description>...</description>
</n----->