com.liferay.document.library.kernel.util

Interface DL

@ProviderType
public interface DL

Author:

Eudaldo Alonso

Field Summary

Fields

Modifier and Type	Field and Description
static String	MANUAL_CHECK_IN_REQUIRED
static String	MANUAL_CHECK_IN_REQUIRED_PATH
static String	OFFICE_EXTENSION
static String	OFFICE_EXTENSION_PATH
static String	WEBDAV_CHECK_IN_MODE

Method Summary

Modifier and Type	Method and Description
int	compareVersions(String version1, String version2)
String	getAbsolutePath(PortletRequest portletRequest, long folderId)
Set<String>	getAllMediaGalleryMimeTypes()
String	getDDMStructureKey(DLFileEntryType dlFileEntryType)
String	getDDMStructureKey(String fileEntryTypeUuid)
String	getDeprecatedDDMStructureKey(DLFileEntryType dlFileEntryType)
String	getDeprecatedDDMStructureKey(long fileEntryTypeId)
String	getDividedPath(long id)
String	getDLFileEntryControlPanelLink(PortletRequest portletRequest, long fileEntryId)
String	getDLFolderControlPanelLink(PortletRequest portletRequest, long folderId)
String	getDownloadURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, String queryString)
String	getDownloadURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, String queryString, boolean appendVersion, boolean absoluteURL)
Map<String,String>	getEmailDefinitionTerms(PortletRequest portletRequest, String emailFromAddress, String emailFromName)
Map<String,String>	getEmailFromDefinitionTerms(PortletRequest portletRequest, String emailFromAddress, String emailFromName)
List<FileEntry>	getFileEntries(Hits hits)
String	getFileEntryImage(FileEntry fileEntry, ThemeDisplay themeDisplay)
Set<Long>	getFileEntryTypeSubscriptionClassPKs(long userId)
String	getFileIcon(String extension)
String	getFileIconCssClass(String extension)
String	getGenericName(String extension)
String	getImagePreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay)
String	getImagePreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, String queryString, boolean appendVersion, boolean absoluteURL)
String	getImagePreviewURL(FileEntry fileEntry, ThemeDisplay themeDisplay)
String	getPreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, String queryString)
String	getPreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, String queryString, boolean appendVersion, boolean absoluteURL)
<T> OrderByComparator<T>	getRepositoryModelOrderByComparator(String orderByCol, String orderByType)
<T> OrderByComparator<T>	getRepositoryModelOrderByComparator(String orderByCol, String orderByType, boolean orderByModel)
String	getSanitizedFileName(String title, String extension)
String	getTempFileId(long id, String version)
String	getTempFileId(long id, String version, String languageId)
String	getThumbnailSrc(FileEntry fileEntry, DLFileShortcut dlFileShortcut, ThemeDisplay themeDisplay) Deprecated. As of Wilberforce (7.0.x), replaced by getThumbnailSrc(FileEntry, ThemeDisplay)
String	getThumbnailSrc(FileEntry fileEntry, FileVersion fileVersion, DLFileShortcut dlFileShortcut, ThemeDisplay themeDisplay) Deprecated. As of Wilberforce (7.0.x), replaced by getThumbnailSrc(FileEntry, FileVersion, ThemeDisplay)
String	getThumbnailSrc(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay)
String	getThumbnailSrc(FileEntry fileEntry, ThemeDisplay themeDisplay)
String	getThumbnailStyle()
String	getThumbnailStyle(boolean max, int margin)
String	getThumbnailStyle(boolean max, int margin, int height, int width)
String	getTitleWithExtension(FileEntry fileEntry)
String	getTitleWithExtension(String title, String extension)
String	getUniqueFileName(long groupId, long folderId, String fileName)
String	getWebDavURL(ThemeDisplay themeDisplay, Folder folder, FileEntry fileEntry)
String	getWebDavURL(ThemeDisplay themeDisplay, Folder folder, FileEntry fileEntry, boolean manualCheckInRequired)
String	getWebDavURL(ThemeDisplay themeDisplay, Folder folder, FileEntry fileEntry, boolean manualCheckInRequired, boolean officeExtensionRequired)
boolean	hasWorkflowDefinitionLink(long companyId, long groupId, long folderId, long fileEntryTypeId)
boolean	isAutoGeneratedDLFileEntryTypeDDMStructureKey(String ddmStructureKey)
boolean	isOfficeExtension(String extension)
boolean	isSubscribedToFileEntryType(long companyId, long groupId, long userId, long fileEntryTypeId)
boolean	isSubscribedToFolder(long companyId, long groupId, long userId, long folderId)
boolean	isSubscribedToFolder(long companyId, long groupId, long userId, long folderId, boolean recursive)
boolean	isValidVersion(String version)
void	startWorkflowInstance(long userId, DLFileVersion dlFileVersion, String syncEventType, ServiceContext serviceContext)

Field Detail

MANUAL_CHECK_IN_REQUIRED

static final String MANUAL_CHECK_IN_REQUIRED

See Also:

Constant Field Values

MANUAL_CHECK_IN_REQUIRED_PATH

static final String MANUAL_CHECK_IN_REQUIRED_PATH

See Also:

Constant Field Values

OFFICE_EXTENSION

static final String OFFICE_EXTENSION

See Also:

Constant Field Values

OFFICE_EXTENSION_PATH

static final String OFFICE_EXTENSION_PATH

See Also:

Constant Field Values

WEBDAV_CHECK_IN_MODE

static final String WEBDAV_CHECK_IN_MODE

See Also:

Constant Field Values

Method Detail

compareVersions

int compareVersions(String version1,
                    String version2)

getAbsolutePath

String getAbsolutePath(PortletRequest portletRequest,
                       long folderId)
                throws PortalException

Throws:

PortalException

getAllMediaGalleryMimeTypes

Set<String> getAllMediaGalleryMimeTypes()

getDDMStructureKey

String getDDMStructureKey(DLFileEntryType dlFileEntryType)

getDDMStructureKey

String getDDMStructureKey(String fileEntryTypeUuid)

getDeprecatedDDMStructureKey

String getDeprecatedDDMStructureKey(DLFileEntryType dlFileEntryType)

getDeprecatedDDMStructureKey

String getDeprecatedDDMStructureKey(long fileEntryTypeId)

getDividedPath

String getDividedPath(long id)

getDLFileEntryControlPanelLink

String getDLFileEntryControlPanelLink(PortletRequest portletRequest,
                                      long fileEntryId)
                               throws PortalException

Throws:

PortalException

getDLFolderControlPanelLink

String getDLFolderControlPanelLink(PortletRequest portletRequest,
                                   long folderId)
                            throws PortalException

Throws:

PortalException

getDownloadURL

String getDownloadURL(FileEntry fileEntry,
                      FileVersion fileVersion,
                      ThemeDisplay themeDisplay,
                      String queryString)

getDownloadURL

String getDownloadURL(FileEntry fileEntry,
                      FileVersion fileVersion,
                      ThemeDisplay themeDisplay,
                      String queryString,
                      boolean appendVersion,
                      boolean absoluteURL)

getEmailDefinitionTerms

Map<String,String> getEmailDefinitionTerms(PortletRequest portletRequest,
                                           String emailFromAddress,
                                           String emailFromName)

getEmailFromDefinitionTerms

Map<String,String> getEmailFromDefinitionTerms(PortletRequest portletRequest,
                                               String emailFromAddress,
                                               String emailFromName)

getFileEntries

List<FileEntry> getFileEntries(Hits hits)

getFileEntryImage

String getFileEntryImage(FileEntry fileEntry,
                         ThemeDisplay themeDisplay)

getFileEntryTypeSubscriptionClassPKs

Set<Long> getFileEntryTypeSubscriptionClassPKs(long userId)

getFileIcon

String getFileIcon(String extension)

getFileIconCssClass

String getFileIconCssClass(String extension)

getGenericName

String getGenericName(String extension)

getImagePreviewURL

String getImagePreviewURL(FileEntry fileEntry,
                          FileVersion fileVersion,
                          ThemeDisplay themeDisplay)
                   throws Exception

Throws:

Exception

getImagePreviewURL

String getImagePreviewURL(FileEntry fileEntry,
                          FileVersion fileVersion,
                          ThemeDisplay themeDisplay,
                          String queryString,
                          boolean appendVersion,
                          boolean absoluteURL)
                   throws PortalException

Throws:

PortalException

getImagePreviewURL

String getImagePreviewURL(FileEntry fileEntry,
                          ThemeDisplay themeDisplay)
                   throws Exception

Throws:

Exception

getPreviewURL

String getPreviewURL(FileEntry fileEntry,
                     FileVersion fileVersion,
                     ThemeDisplay themeDisplay,
                     String queryString)

getPreviewURL

String getPreviewURL(FileEntry fileEntry,
                     FileVersion fileVersion,
                     ThemeDisplay themeDisplay,
                     String queryString,
                     boolean appendVersion,
                     boolean absoluteURL)

getRepositoryModelOrderByComparator

<T> OrderByComparator<T> getRepositoryModelOrderByComparator(String orderByCol,
                                                             String orderByType)

getRepositoryModelOrderByComparator

<T> OrderByComparator<T> getRepositoryModelOrderByComparator(String orderByCol,
                                                             String orderByType,
                                                             boolean orderByModel)

getSanitizedFileName

String getSanitizedFileName(String title,
                            String extension)

getTempFileId

String getTempFileId(long id,
                     String version)

getTempFileId

String getTempFileId(long id,
                     String version,
                     String languageId)

getThumbnailSrc

@Deprecated
String getThumbnailSrc(FileEntry fileEntry,
                                   DLFileShortcut dlFileShortcut,
                                   ThemeDisplay themeDisplay)
                            throws Exception

Deprecated. As of Wilberforce (7.0.x), replaced by getThumbnailSrc(FileEntry, ThemeDisplay)

Throws:

Exception

getThumbnailSrc

@Deprecated
String getThumbnailSrc(FileEntry fileEntry,
                                   FileVersion fileVersion,
                                   DLFileShortcut dlFileShortcut,
                                   ThemeDisplay themeDisplay)
                            throws Exception

Deprecated. As of Wilberforce (7.0.x), replaced by getThumbnailSrc(FileEntry, FileVersion, ThemeDisplay)

Throws:

Exception

getThumbnailSrc

String getThumbnailSrc(FileEntry fileEntry,
                       FileVersion fileVersion,
                       ThemeDisplay themeDisplay)
                throws Exception

Throws:

Exception

getThumbnailSrc

String getThumbnailSrc(FileEntry fileEntry,
                       ThemeDisplay themeDisplay)
                throws Exception

Throws:

Exception

getThumbnailStyle

String getThumbnailStyle()

getThumbnailStyle

String getThumbnailStyle(boolean max,
                         int margin)

getThumbnailStyle

String getThumbnailStyle(boolean max,
                         int margin,
                         int height,
                         int width)

getTitleWithExtension

String getTitleWithExtension(FileEntry fileEntry)

getTitleWithExtension

String getTitleWithExtension(String title,
                             String extension)

getUniqueFileName

String getUniqueFileName(long groupId,
                         long folderId,
                         String fileName)

getWebDavURL

String getWebDavURL(ThemeDisplay themeDisplay,
                    Folder folder,
                    FileEntry fileEntry)
             throws PortalException

Throws:

PortalException

getWebDavURL

String getWebDavURL(ThemeDisplay themeDisplay,
                    Folder folder,
                    FileEntry fileEntry,
                    boolean manualCheckInRequired)
             throws PortalException

Throws:

PortalException

getWebDavURL

String getWebDavURL(ThemeDisplay themeDisplay,
                    Folder folder,
                    FileEntry fileEntry,
                    boolean manualCheckInRequired,
                    boolean officeExtensionRequired)
             throws PortalException

Throws:

PortalException

hasWorkflowDefinitionLink

boolean hasWorkflowDefinitionLink(long companyId,
                                  long groupId,
                                  long folderId,
                                  long fileEntryTypeId)
                           throws Exception

Throws:

Exception

isAutoGeneratedDLFileEntryTypeDDMStructureKey

boolean isAutoGeneratedDLFileEntryTypeDDMStructureKey(String ddmStructureKey)

isOfficeExtension

boolean isOfficeExtension(String extension)

isSubscribedToFileEntryType

boolean isSubscribedToFileEntryType(long companyId,
                                    long groupId,
                                    long userId,
                                    long fileEntryTypeId)

isSubscribedToFolder

boolean isSubscribedToFolder(long companyId,
                             long groupId,
                             long userId,
                             long folderId)
                      throws PortalException

Throws:

PortalException

isSubscribedToFolder

boolean isSubscribedToFolder(long companyId,
                             long groupId,
                             long userId,
                             long folderId,
                             boolean recursive)
                      throws PortalException

Throws:

PortalException

isValidVersion

boolean isValidVersion(String version)

startWorkflowInstance

void startWorkflowInstance(long userId,
                           DLFileVersion dlFileVersion,
                           String syncEventType,
                           ServiceContext serviceContext)
                    throws PortalException

Throws:

PortalException