getDataDefFieldXml

 

Function Name: getDataDefFieldXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to generate Data field Xml.

 

Input Parameters

Output Parameters

 

Prototype:

 

public String getDataDefFieldXml

(

 

 

 

String indexid,

 

 

String indexName,

 

 

String indexType,

 

 

String indexLength,

 

 

String indexAttribute,

 

 

String usefulInfoFlag,

 

 

String usefulInfoSize,

 

 

String indexFlag

 

)

 

 

 

Overloaded Function:

public String getDataDefFieldXml (

                                                                   String indexid,

                                                                   String indexName,

                                                                   String indexType,

                                                                   String indexLength,

                                                                  String indexAttribute,

                                                                  String usefulInfoFlag,

                                                                  String usefulInfoSize,

                                                                 String indexFlag,

                                                                 String indexValue

                                                           )  

 

Input Parameters :

Name

Description

Valid Values

Default Behavior

indexid

Index of the field.

Integer > 0

0

indexName

Name of the field.

 

Blank

indexType

Type of the field.

Integer, Boolean, Date, Float, Long, String, Text, X(Document Index)

Blank

indexLength

Size of the field.

Depends upon index type.

Blank

indexAttribute

Constraint of the field.

0 for null, 1 for not null, 2 for unique null, 3 for unique not null, 4, 5 same as 0,1 respectively except that they are search keys.

Blank

usefulInfoFlag

If a field is marked as UsefulInfo, value of that field can be seen in the document table under the UseFullData column.

Y or N

N

usefulInfoSize

Size of the field.

Depends upon the index type

Blank

indexFlag

Information about index flag whether it would be Global or Data class level.

Global or Data Class

D

indexValue

Value of the data field.

 

 

 

Output Parameters:

Xml containing all Properties of the Field.

<Field>

<IndexId>41</IndexId>

<IndexName>ddded</IndexName>

<IndexType>B</IndexType>

<IndexLength>1</IndexLength>

<IndexAttribute>1</IndexAttribute>

<UsefulInfoFlag>N</UsefulInfoFlag>

<UsefulInfoSize>0</UsefulInfoSize>

<IndexFlag>G</IndexFlag>

</Field>