Change Folder Property

 

Function Name:  getChangeFolderPropertyXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to change an existing folder property from the system. User has to send only those parameters that user wants to change else send null. For those parameters that are null, the original/previous value retained.

 

 

Input Parameters	Sample InputXML
Output Parameters	Sample OutputXML
View xml API::NGOChangeFolderProperty

 

Prototype:

public String getChangeFolderPropertyXml( String cabinetName, String userDbId,

String accessDateTime,

String accessType,String folderIndex,

String folderName,String imageVolIndex,

String folderLock, String lockByUser, 

String mappedDirectory,

String versionFlag, String comment,

String finalizedFlag, String dataDefList,

String owner, String EnableFTSFlag,

String NameLength, String duplicateName,

String logGeneration, String expiryDateTime);

 

Overloaded Function: 

public String getChangeFolderPropertyXml( String cabinetName, String userDbId,

                                                                                 String accessDateTime,

                                                                                 String accessType,String folderIndex,

                                                                                 String folderName,String imageVolIndex,

                                                                                  String folderLock, String lockByUser,  

                                                                                 String mappedDirectory,

                                                                                 String versionFlag, String comment,

                                                                                 String finalizedFlag, String dataDefList,

                                                                                 String owner, String EnableFTSFlag,

                                                                                 String NameLength);

Input Parameters:

Name	Description	Valid Values	Default Behavior
cabinetName	Name of the Database Cabinet to which the User wants to connect.		N/A
userDBId	UserDatabase ID, which is returned after the execution of getConnectCabinetXml call.		N/A
accessDateTime	Access Date and Time of the Folder.	A valid Date in the format yyyy-mm-dd hh:mm:ss
accessType	Access Type of the Folder.	S- Shared, P- Private, I -Inherit	S
folderIndex	Index of the Folder.	Integer > 0	N/A
folderName	New Name of the Folder.	Any String (Valid)
imageVolIndex	Image Volume Index of the Folder.	Integer > 0
folderLock	Folder is locked or not.	Y/N	N
lockByUser	Locked by the User or not.	1 or 0	0
mappedDirectory	Reserved.	Null
versionFlag	When the documents to be added to a Folder that is marked ‘Y’ for Auto Version, without mentioning AutoVersion Flag then the value determined for that Folder is taken.	Y/N	N
comment	Any comment associated with the Folder.	Any String (Valid)	null
finalizedFlag	Flag that indicates whether the Folder Properties are finalized or not.	Y/N	N
dataDefList	New/Modified Data Definition list. This list can be generated using function getDataDefFieldXml.		N/A
owner	Name of the new Owner of the Folder.	A valid Owner Name.	null
EnableFTSFlag	This is used to set the FTS flag for the folder.	Y/N
NameLength	Length of the name of the folder.	Integer greater than 0
duplicateName	Whether duplicate name is to be generated or not.	Y or N	N
logGeneration	Whether log is to be generated for this action or not.	Y or N	Y
expiryDateTime	Specifies the Date and Time when the Folder Expires.

 

Output Parameters:

An InputXml string of the NGOChangeFolderProperty call.