ImportFolder

From LogicalDOC Community Wiki

Contents 1 WSImportFolder[] list(String sid) 2 long store(String sid, WSImportFolder folder) 3 void delete(String sid, long folderId)

Methods to retrieve and manage the imported folders.

WSImportFolder[] list(String sid)

This operation allows to retrieve folder metadata of all imported folders.

Parameters

• sid - The session identifier.

Returns

• Array of WSImportFolder

Throws

• Exception - If there is any error retrieving the folders metadata.

long store(String sid, WSImportFolder folder)

This operation allows to store/update an imported folder. You can completely customize the imported folder through a value object containing the import folder's metadata.

Parameters

• sid - The session identifier.
• folder - The import folder's metadata

Returns

• id of the created/updated import folder.

Throws

• Exception - If there is any error storing or updating the import folder.

void delete(String sid, long folderId)

Deletes an import folder with the given identifier.

Parameters

• sid - The session identifier.
• folderId Identifier of the import folder to be deleted

Returns

• nothing

Throws

• Exception - If there is any error deleting the import folder.