com.liferay.portlet.documentlibrary.util

Interface DL

public interface DL

Author:

Eudaldo Alonso

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addPortletBreadcrumbEntries(DLFileShortcut dlFileShortcut, javax.servlet.http.HttpServletRequest request, javax.portlet.RenderResponse renderResponse)
void	addPortletBreadcrumbEntries(FileEntry fileEntry, javax.servlet.http.HttpServletRequest request, javax.portlet.RenderResponse renderResponse)
void	addPortletBreadcrumbEntries(Folder folder, javax.servlet.http.HttpServletRequest request, LiferayPortletResponse liferayPortletResponse)
void	addPortletBreadcrumbEntries(Folder folder, javax.servlet.http.HttpServletRequest request, javax.portlet.PortletURL portletURL)
void	addPortletBreadcrumbEntries(Folder folder, javax.servlet.http.HttpServletRequest request, javax.portlet.RenderResponse renderResponse)
void	addPortletBreadcrumbEntries(long folderId, javax.servlet.http.HttpServletRequest request, javax.portlet.RenderResponse renderResponse)
int	compareVersions(java.lang.String version1, java.lang.String version2)
java.lang.String	getAbsolutePath(javax.portlet.PortletRequest portletRequest, long folderId)
java.util.Set<java.lang.String>	getAllMediaGalleryMimeTypes()
java.lang.String	getDDMStructureKey(DLFileEntryType dlFileEntryType)
java.lang.String	getDDMStructureKey(java.lang.String fileEntryTypeUuid)
java.lang.String	getDeprecatedDDMStructureKey(DLFileEntryType dlFileEntryType)
java.lang.String	getDeprecatedDDMStructureKey(long fileEntryTypeId)
java.lang.String	getDividedPath(long id)
java.lang.String	getDLFileEntryControlPanelLink(javax.portlet.PortletRequest portletRequest, long fileEntryId)
java.lang.String	getDLFolderControlPanelLink(javax.portlet.PortletRequest portletRequest, long folderId)
java.util.Map<java.util.Locale,java.lang.String>	getEmailFileEntryAddedBodyMap(javax.portlet.PortletPreferences preferences)
boolean	getEmailFileEntryAddedEnabled(javax.portlet.PortletPreferences preferences)
java.util.Map<java.util.Locale,java.lang.String>	getEmailFileEntryAddedSubjectMap(javax.portlet.PortletPreferences preferences)
java.util.Map<java.util.Locale,java.lang.String>	getEmailFileEntryUpdatedBodyMap(javax.portlet.PortletPreferences preferences)
boolean	getEmailFileEntryUpdatedEnabled(javax.portlet.PortletPreferences preferences)
java.util.Map<java.util.Locale,java.lang.String>	getEmailFileEntryUpdatedSubjectMap(javax.portlet.PortletPreferences preferences)
java.lang.String	getEmailFromAddress(javax.portlet.PortletPreferences preferences, long companyId)
java.lang.String	getEmailFromName(javax.portlet.PortletPreferences preferences, long companyId)
java.util.List<java.lang.Object>	getEntries(Hits hits)
java.lang.String	getFileEntryImage(FileEntry fileEntry, ThemeDisplay themeDisplay)
java.util.Set<java.lang.Long>	getFileEntryTypeSubscriptionClassPKs(long userId)
java.lang.String	getFileIcon(java.lang.String extension)
java.lang.String	getGenericName(java.lang.String extension)
java.lang.String	getImagePreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay)
java.lang.String	getImagePreviewURL(FileEntry fileEntry, ThemeDisplay themeDisplay)
java.lang.String[]	getMediaGalleryMimeTypes(javax.portlet.PortletPreferences portletPreferences, javax.portlet.PortletRequest portletRequest)
java.lang.String	getPreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, java.lang.String queryString)
java.lang.String	getPreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, java.lang.String queryString, boolean appendToken) Deprecated. As of 6.2.0, replaced by getPreviewURL(FileEntry, FileVersion, ThemeDisplay, String, boolean, boolean)
java.lang.String	getPreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, java.lang.String queryString, boolean appendVersion, boolean absoluteURL)
OrderByComparator	getRepositoryModelOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
java.lang.String	getTempFileId(long id, java.lang.String version)
java.lang.String	getTempFileId(long id, java.lang.String version, java.lang.String languageId)
java.lang.String	getThumbnailSrc(FileEntry fileEntry, DLFileShortcut dlFileShortcut, ThemeDisplay themeDisplay)
java.lang.String	getThumbnailSrc(FileEntry fileEntry, FileVersion fileVersion, DLFileShortcut dlFileShortcut, ThemeDisplay themeDisplay)
java.lang.String	getThumbnailStyle()
java.lang.String	getThumbnailStyle(boolean max, int margin)
java.lang.String	getTitleWithExtension(FileEntry fileEntry)
java.lang.String	getTitleWithExtension(java.lang.String title, java.lang.String extension)
java.lang.String	getWebDavURL(ThemeDisplay themeDisplay, Folder folder, FileEntry fileEntry)
java.lang.String	getWebDavURL(ThemeDisplay themeDisplay, Folder folder, FileEntry fileEntry, boolean manualCheckInRequired)
java.lang.String	getWebDavURL(ThemeDisplay themeDisplay, Folder folder, FileEntry fileEntry, boolean manualCheckInRequired, boolean officeExtensionRequired)
boolean	hasWorkflowDefinitionLink(long companyId, long groupId, long folderId, long fileEntryTypeId)
boolean	isAutoGeneratedDLFileEntryTypeDDMStructureKey(java.lang.String ddmStructureKey)
boolean	isOfficeExtension(java.lang.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(java.lang.String version)

Field Detail

MANUAL_CHECK_IN_REQUIRED

static final java.lang.String MANUAL_CHECK_IN_REQUIRED

See Also:

Constant Field Values

MANUAL_CHECK_IN_REQUIRED_PATH

static final java.lang.String MANUAL_CHECK_IN_REQUIRED_PATH

See Also:

Constant Field Values

OFFICE_EXTENSION

static final java.lang.String OFFICE_EXTENSION

See Also:

Constant Field Values

OFFICE_EXTENSION_PATH

static final java.lang.String OFFICE_EXTENSION_PATH

See Also:

Constant Field Values

WEBDAV_CHECK_IN_MODE

static final java.lang.String WEBDAV_CHECK_IN_MODE

See Also:

Constant Field Values

Method Detail

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(DLFileShortcut dlFileShortcut,
                               javax.servlet.http.HttpServletRequest request,
                               javax.portlet.RenderResponse renderResponse)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(FileEntry fileEntry,
                               javax.servlet.http.HttpServletRequest request,
                               javax.portlet.RenderResponse renderResponse)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(Folder folder,
                               javax.servlet.http.HttpServletRequest request,
                               LiferayPortletResponse liferayPortletResponse)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(Folder folder,
                               javax.servlet.http.HttpServletRequest request,
                               javax.portlet.PortletURL portletURL)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(Folder folder,
                               javax.servlet.http.HttpServletRequest request,
                               javax.portlet.RenderResponse renderResponse)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(long folderId,
                               javax.servlet.http.HttpServletRequest request,
                               javax.portlet.RenderResponse renderResponse)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

compareVersions

int compareVersions(java.lang.String version1,
                  java.lang.String version2)

getAbsolutePath

java.lang.String getAbsolutePath(javax.portlet.PortletRequest portletRequest,
                               long folderId)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getAllMediaGalleryMimeTypes

java.util.Set<java.lang.String> getAllMediaGalleryMimeTypes()

getDDMStructureKey

java.lang.String getDDMStructureKey(DLFileEntryType dlFileEntryType)

getDDMStructureKey

java.lang.String getDDMStructureKey(java.lang.String fileEntryTypeUuid)

getDeprecatedDDMStructureKey

java.lang.String getDeprecatedDDMStructureKey(DLFileEntryType dlFileEntryType)

getDeprecatedDDMStructureKey

java.lang.String getDeprecatedDDMStructureKey(long fileEntryTypeId)

getDividedPath

java.lang.String getDividedPath(long id)

getDLFileEntryControlPanelLink

java.lang.String getDLFileEntryControlPanelLink(javax.portlet.PortletRequest portletRequest,
                                              long fileEntryId)
                                                throws PortalException,
                                                       SystemException

Throws:

PortalException

SystemException

getDLFolderControlPanelLink

java.lang.String getDLFolderControlPanelLink(javax.portlet.PortletRequest portletRequest,
                                           long folderId)
                                             throws PortalException,
                                                    SystemException

Throws:

PortalException

SystemException

getEmailFileEntryAddedBodyMap

java.util.Map<java.util.Locale,java.lang.String> getEmailFileEntryAddedBodyMap(javax.portlet.PortletPreferences preferences)

getEmailFileEntryAddedEnabled

boolean getEmailFileEntryAddedEnabled(javax.portlet.PortletPreferences preferences)

getEmailFileEntryAddedSubjectMap

java.util.Map<java.util.Locale,java.lang.String> getEmailFileEntryAddedSubjectMap(javax.portlet.PortletPreferences preferences)

getEmailFileEntryUpdatedBodyMap

java.util.Map<java.util.Locale,java.lang.String> getEmailFileEntryUpdatedBodyMap(javax.portlet.PortletPreferences preferences)

getEmailFileEntryUpdatedEnabled

boolean getEmailFileEntryUpdatedEnabled(javax.portlet.PortletPreferences preferences)

getEmailFileEntryUpdatedSubjectMap

java.util.Map<java.util.Locale,java.lang.String> getEmailFileEntryUpdatedSubjectMap(javax.portlet.PortletPreferences preferences)

getEmailFromAddress

java.lang.String getEmailFromAddress(javax.portlet.PortletPreferences preferences,
                                   long companyId)
                                     throws SystemException

Throws:

SystemException

getEmailFromName

java.lang.String getEmailFromName(javax.portlet.PortletPreferences preferences,
                                long companyId)
                                  throws SystemException

Throws:

SystemException

getEntries

java.util.List<java.lang.Object> getEntries(Hits hits)

getFileEntryImage

java.lang.String getFileEntryImage(FileEntry fileEntry,
                                 ThemeDisplay themeDisplay)

getFileEntryTypeSubscriptionClassPKs

java.util.Set<java.lang.Long> getFileEntryTypeSubscriptionClassPKs(long userId)
                                                                   throws SystemException

Throws:

SystemException

getFileIcon

java.lang.String getFileIcon(java.lang.String extension)

getGenericName

java.lang.String getGenericName(java.lang.String extension)

getImagePreviewURL

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

Throws:

java.lang.Exception

getImagePreviewURL

java.lang.String getImagePreviewURL(FileEntry fileEntry,
                                  ThemeDisplay themeDisplay)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getMediaGalleryMimeTypes

java.lang.String[] getMediaGalleryMimeTypes(javax.portlet.PortletPreferences portletPreferences,
                                          javax.portlet.PortletRequest portletRequest)

getPreviewURL

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

getPreviewURL

java.lang.String getPreviewURL(FileEntry fileEntry,
                             FileVersion fileVersion,
                             ThemeDisplay themeDisplay,
                             java.lang.String queryString,
                             boolean appendToken)

Deprecated. As of 6.2.0, replaced by getPreviewURL(FileEntry, FileVersion, ThemeDisplay, String, boolean, boolean)

getPreviewURL

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

getRepositoryModelOrderByComparator

OrderByComparator getRepositoryModelOrderByComparator(java.lang.String orderByCol,
                                                    java.lang.String orderByType)

getTempFileId

java.lang.String getTempFileId(long id,
                             java.lang.String version)

getTempFileId

java.lang.String getTempFileId(long id,
                             java.lang.String version,
                             java.lang.String languageId)

getThumbnailSrc

java.lang.String getThumbnailSrc(FileEntry fileEntry,
                               DLFileShortcut dlFileShortcut,
                               ThemeDisplay themeDisplay)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getThumbnailSrc

java.lang.String getThumbnailSrc(FileEntry fileEntry,
                               FileVersion fileVersion,
                               DLFileShortcut dlFileShortcut,
                               ThemeDisplay themeDisplay)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getThumbnailStyle

java.lang.String getThumbnailStyle()
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getThumbnailStyle

java.lang.String getThumbnailStyle(boolean max,
                                 int margin)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getTitleWithExtension

java.lang.String getTitleWithExtension(FileEntry fileEntry)

getTitleWithExtension

java.lang.String getTitleWithExtension(java.lang.String title,
                                     java.lang.String extension)

getWebDavURL

java.lang.String getWebDavURL(ThemeDisplay themeDisplay,
                            Folder folder,
                            FileEntry fileEntry)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getWebDavURL

java.lang.String getWebDavURL(ThemeDisplay themeDisplay,
                            Folder folder,
                            FileEntry fileEntry,
                            boolean manualCheckInRequired)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getWebDavURL

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

Throws:

PortalException

SystemException

hasWorkflowDefinitionLink

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

Throws:

java.lang.Exception

isAutoGeneratedDLFileEntryTypeDDMStructureKey

boolean isAutoGeneratedDLFileEntryTypeDDMStructureKey(java.lang.String ddmStructureKey)

isOfficeExtension

boolean isOfficeExtension(java.lang.String extension)

isSubscribedToFileEntryType

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

Throws:

SystemException

isSubscribedToFolder

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

Throws:

PortalException

SystemException

isSubscribedToFolder

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

Throws:

PortalException

SystemException

isValidVersion

boolean isValidVersion(java.lang.String version)