Delete Folder

Function Name: getDeleteFolderXml

Class: com.newgen.dmsapi.DMSInputXml

Description: This function is used to delete an existing folder permanently from the system. The referenceFlag can be used to avoid deletion of folder if some shortcut exists for some document in that folder or any of its subfolders. Similarly checkOutFlag can also be used to avoid deletion of the folder if some documents in that folder or any of its subfolders are checked out.

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

Prototype:

public String getDeleteFolderXml	(
		String cabinetName,
		String userDbId,
		String folderIndex,
		String referenceFlag,
		String parentFolderIndex ,
		String checkOutFlag
	)

Input Parameters:

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
FolderIndex	Index of the Folder that is to be deleted.		N/A
referenceFlag	It specifies whether to delete the Folder, when the References exist for the documents within that Folder or any of its subfolders.	N – Don’t delete Folder if any Reference for some document within that Folder or any of its subfolders exists. Y – Delete Folder even if Reference exists for some document within that Folder or any of its subfolders.	‘N’
parentFolderIndex	Index of the Parent Folder of the Folder that is to be deleted.	Integer > 0
checkOutFlag	It specifies whether to delete the Folder, when some Checked Out document exist within the Folder or any of its subfolders.	N – Don’t delete Folder if any Checked Out document exist within the Folder or any of its subfolders. Y – Delete folder even if any Checked Out document exist within the Folder or any of its subfolders.	‘Y’

Output Parameters:

An ~~inputXml~~InputXml string of the NGODeleteFolder call.