Function
Name:
getDeleteReferencesXml
Class:
com.newgen.dmsapi.DMSInputXml
Description:
This function is used to delete the Shortcuts or References of a document or a
Folder. DeleteAll flag enables the deletion of all the References for that
Folder or document anywhere in the System.
|
Prototype:
public String getDeleteReferencesXml |
( |
|
|
|
String cabinetName, String userDbId, |
|
|
String currDateTime, String srcIndex, |
|
|
String foldDocFlag, String deleteAll, |
|
|
String objIdList |
|
) |
|
Name |
Description |
Valid Values |
Default Behaviour |
cabinetName |
Name of the
Database Cabinet to which the User wants to connect. |
|
N/A |
userDbId |
User Database ID,
which is returned in the ConnectCabinet call. |
|
N/A |
currDateTime |
Current Date and
Time. |
Valid Date in the
format yyyy-mm-dd hh:mm:ss |
Current Date and
Time. |
srcIndex |
Folder Index from
where shortcuts are to be deleted. |
Integer > 0 |
N/A |
foldDocFlag |
Type of the Object
whose shortcut is to be deleted. |
�F�-Folder �D�- Document |
D |
deleteAll |
Indicates if all
shortcuts of a given Object are to be deleted. |
�Y� �Yes �N� � No |
N |
objIdList |
List of Object
Indices whose shortcuts have to be deleted. The List is generated by the
helper function, getObjectIndexXml. |
Integer > 0 |
N/A |
An Input Xml for
NGODeleteReferences.