Process Locks

Function Name: getProcessLocksXml

Class: com.newgen.dmsapi.DMSInputXml

Description: The functionality of Locking and Unlocking of document, Folder or Cabinet can be achieved using this function. Supplying VersionNo can also lock any particular Version of a document.

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

Prototype:

public String getProcessLocksXml	(
		String cabinetName, String userDbId,
		String currentDate, String versionNo,
		String type,
		String objectType, String objectIndex
		String lockMessage
	)

Overloaded Functions:

public String getProcessLocksXml	(
		String cabinetName, String userDbId,
		String currentDate, String versionNo,
		String type,
		String objectType, String objectIndex
	)

Input Parameters:

Name	Description	Valid Values	Default Behaviour
CabinetName	Name of the Database Cabinet to which the User wants to connect.	The name of the Cabinet.	N/A
UserDbId	UserDatabase ID, which is returned after the execution of getConnectCabinetXml call.		N/A
CurrentDate	Date and Time when this document is being locked / unlocked.	Valid Date in the format- yyyy-mm-dd hh:mm:ss	Current System Date and Time.
Type	The desired type of operation namely, Lock or Unlock.	‘Y’ – Lock ‘N’ – Unlock ‘A’ – Release all locks	N/A
VersionNo	The Version of the document that is to be Locked or Unlocked.	X. Y where X>=1 and Y>=0	Latest Version of the document.
ObjectType	Type of Object on which Locking / Unlocking operation is being performed.	‘D’ – Document ‘F’ – Folder ‘U’ – User. If any other value is given, then Exception will be thrown.
ObjectIndex	Index of the Object on which Locking / Unlocking operation is being performed.	Integer >=0	N/A
LockMessage	Lock message attached with the object.		NULL

Output Parameters:

An inputXml string of the NGOProcessLock call.