Package com.logicaldoc.core.automation

Class FolderTool

java.lang.Object

com.logicaldoc.core.automation.FolderTool

public class FolderTool
extends Object

Utility methods to handle folders from within the Automation

Since:

7.3

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
FolderTool()

Method Summary

Modifier and Type	Method	Description
String	displayUrl(long tenantId, long folderId)	Prints the URL to display the folder inside the User Interface
String	displayUrl(Folder folder)	Prints the URL to display the folder inside the User Interface
String	displayUrl(FolderHistory history)	Prints the URL to display the folder inside the User Interface
Folder	findByPath(String path)	Finds the folder by it's path
Folder	findByPath(String path, Long tenantId)	Finds the folder by it's path
String	getPath(Long folderId)	Calculates the full path of a folder

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FolderTool

public FolderTool()

Method Detail

displayUrl

public String displayUrl(long tenantId,
                         long folderId)

Prints the URL to display the folder inside the User Interface

Parameters:

tenantId - identifier of the tenant

folderId - identifier of the folder

Returns:

the display URL

displayUrl

public String displayUrl(Folder folder)

Prints the URL to display the folder inside the User Interface

Parameters:

folder - the folder to display

Returns:

the display URL

displayUrl

public String displayUrl(FolderHistory history)

Prints the URL to display the folder inside the User Interface

Parameters:

history - event from which to get the folder's to display

Returns:

the display URL

getPath

public String getPath(Long folderId)

Calculates the full path of a folder

Parameters:

folderId - identifier of the folder

Returns:

the path

findByPath

public Folder findByPath(String path)

Finds the folder by it's path

Parameters:

path - the path to process

Returns:

the found folder

findByPath

public Folder findByPath(String path,
                         Long tenantId)

Finds the folder by it's path

Parameters:

path - the path to process

tenantId - identifier of the tenant

Returns:

the found folder