Function
Name:
getMoveFolderXml
Class:
com.newgen.dmsapi.DMSInputXml
Description: This function is used to move a folder from one location to
another.
|
Prototype:
public
String getMoveFolderXml(String cabinetName, String userDbId,
String creationDateTime, String moveFolderIndex,
String destFolderIndex, String parentFolderIndex,
String checkOutFlag, String NameLength,
String DuplicateName,
String LockFlag,
String RightsFlag)
Overloaded Function:
public
String getMoveFolderXml(String cabinetName, String userDbId,
String creationDateTime, String moveFolderIndex,
String destFolderIndex, String parentFolderIndex,
String checkOutFlag, String NameLength,
String DuplicateName)
Name |
Description |
Valid Values |
Default Behaviour |
cabinetName |
Name of the Database Cabinet to which the User wants to connect. |
|
N/A |
userDbId |
UserDatabse ID,
which is returned in the ConnectCabinet call. |
|
N/A |
creationDateTime |
Current Date and
Time |
Valid Date in the
format yyyy-mm-dd hh:mm:ss |
Current Date and
Time |
moveFolderIndex |
Index of the Folder
to be moved. |
Integer > 0 |
N/A |
destFolderIndex |
Index of the
destination Folder where the specified Folder is to be moved. |
Integer > 0 |
N/A |
parentFolderIndex |
Parent Folder Index
of Folder to be moved. |
Integer > 0 |
|
checkOutFlag |
It specifies
whether to move the Folder, when some Checked Out document exist within the
Folder or any of its subfolders. |
N – Don’t move
Folder if any Checked Out document exists within that Folder or any of its
subfolders. Y – Move Folder
even if any Checked Out document exists within that Folder or any of its
subfolders. |
‘Y’ |
NameLength |
Length of the name of the folder |
|
|
DuplicateName |
This parameter specifies whether the duplicate
name is allowed
in case folder with same name is there in the destination folder. |
Y-Yes N-No |
‘Y’ |
LockFlag |
If document inside the folder is locked, then folder is to be moved or not. |
Y or N |
|
RightsFlag |
Whether login user’s rights are to be checked or not |
Y or N |
‘Y’ |
An
inputXmlInputXml string of the
NGOMoveFolder call.