DocumentLibraryObject class | QSYS API Reference Guide

Estimated reading time: 3 minutes

Provides functionality to manipulate Document Library Objects (DLO).

Namespace: ASNA.QSys.Runtime.JobSupport Assembly: ASNA.QSys.Runtime.dll

Inheritance: Object

Constructors

Name	Description
DocumentLibraryObject(String)	Initializes a new instance of the DocumentLibraryObject class.

Initializes a new instance of the DocumentLibraryObject class.

DocumentLibraryObject(String)

Type	Parameter name	Description
String	dlsRootName	The name of the folder, within the Job’s IFS Root, serving as the root of the DLS objects.

Type	Name	Description
String	IFSRoot	Gets the Current Job IFS root path.

Signature	Description
Check(String, String, DLOType)	Checks that an object exists in the DLO Root, if the object does not exists it throws a CPF exception.
CreateFolder(String, String)	Creates a Folder in another folder within the DLO Root.
GetDLORoot()	Gets the absolute DLO folder path.
Move(String, String, String, String)	Move a document to a new folder and can rename the document in the process.
Rename(String, String, String)	Changes the name of a document or folder.

Checks that an object exists in the DLO Root, if the object does not exists it throws a CPF exception.

void Check(string dloName, string parentFolder, DLOType objectType)

Type	Parameter name	Description
String	dloName	Object Name to look for.
String	parentFolder	Containing object’s parent folder.
DLOType	objectType	Type of object to look for.

Creates a Folder in another folder within the DLO Root.

void CreateFolder(string newFolder, string parentFolder)

Type	Parameter name	Description
String	newFolder	Name of new folder to create.
String	parentFolder	Parent Folder of new folder.

Gets the absolute DLO folder path.

string GetDLORoot()

Move a document to a new folder and can rename the document in the process.

void Move(string docName, string fromFolder, string toFolder, string newName)

Type	Parameter name	Description
String	docName	Name of Document to be moved.
String	fromFolder	Current Document’s parent folder. Use *NONE for DLO root folder.
String	toFolder	New Folder to contain Document. Use *NONE for DLO root folder.
String	newName	New Document Name. Use *SAME to keep original Name of Document.

Changes the name of a document or folder.

void Rename(string dloName, string newName, string parentFolder)

Type	Parameter name	Description
String	dloName	Original Document Name.
String	newName	New Document Name.
String	parentFolder	Document’s containing folder.