Function
Name:
getAddDataDefinitionXml
Class:
com.newgen.dmsapi.DMSInputXml
Description: This function is used to add a new Data Class to the
System. The fields of the Data-Definition can also be specified at the time of
Creation. This function can also be used to check only the existence of the
specified Data-Definition. If the Data-Definition with the same Name and same
fields exists, then a Warning Code 50002 is returned and the existing
Data-Definition is returned along with.
|
|
Prototype:
public String getAddDataDefinitionXml(String cabinetName,
String userDbId,
String
checkExistenceOnly,
String
dataDefName, String comment,
String
enableLogFlag, String type,
String
groupId, String extra, String fieldList
String
limitOnFieldCount, String limitOnDataClassCount)
Overloaded function:
public String getAddDataDefinitionXml(String cabinetName,
String userDbId,
String
checkExistenceOnly,
String
dataDefName, String comment,
String
enableLogFlag, String type,
String
groupId, String extra, String fieldList)
|
Name |
Description |
Valid Values |
Default Behaviour |
|
cabinetName |
Name of the
Database Cabinet to which the User wants to connect. |
|
N/A |
|
userDBId |
UserDatabase ID,
which is returned in the ConnectCabinet call. |
|
N/A |
|
CheckExistenceOnly |
Check the existence
of the Data Definition. |
Y or N |
|
|
dataDefName |
Name of the Data
Definition. |
|
New Data
Class(incremented no) |
|
comment |
Any Comment
associated with the Data Definition. |
|
Blank |
|
enableLogFlag |
Maintain Log of the
Data Class. |
Y or N |
N |
|
type |
Type of Data Class.
Nothing predefined type is there. |
ACT or Blank |
Blank |
|
groupId |
Group Index
associated with the Data Definition. It is reserved and User can use default
value. |
Integer >=0 |
0 |
|
extra |
Extra information
stored with the Data Definition. |
|
Blank |
|
fieldList |
Contains the
information about fields’ List. This List can be generated using the function
getDataDefFieldXml. |
|
N/A |
|
LimitOnFieldCount |
Maximum number of Fields that can be attached with a Data
Class. |
Integer >= 1 |
System does not check for any Limit. |
|
LimitOnDataClassCount |
Maximum number of Data Class that are possible with the
current Data Class. |
Integer >= 1 |
System does not check for any Limit. |
An InputXml string of
the NGOAddDataDefinition call.