Liferay 6.2.0

com.liferay.portlet.documentlibrary.util
Interface DL


public interface DL


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

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

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(DLFileShortcut dlFileShortcut,
                                 javax.servlet.http.HttpServletRequest request,
                                 RenderResponse renderResponse)
                                 throws Exception
Throws:
Exception

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(FileEntry fileEntry,
                                 javax.servlet.http.HttpServletRequest request,
                                 RenderResponse renderResponse)
                                 throws Exception
Throws:
Exception

addPortletBreadcrumbEntries

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

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(Folder folder,
                                 javax.servlet.http.HttpServletRequest request,
                                 PortletURL portletURL)
                                 throws Exception
Throws:
Exception

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(Folder folder,
                                 javax.servlet.http.HttpServletRequest request,
                                 RenderResponse renderResponse)
                                 throws Exception
Throws:
Exception

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(long folderId,
                                 javax.servlet.http.HttpServletRequest request,
                                 RenderResponse renderResponse)
                                 throws Exception
Throws:
Exception

compareVersions

int compareVersions(String version1,
                    String version2)

getAbsolutePath

String getAbsolutePath(PortletRequest portletRequest,
                       long folderId)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

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,
                                             SystemException
Throws:
PortalException
SystemException

getDLFolderControlPanelLink

String getDLFolderControlPanelLink(PortletRequest portletRequest,
                                   long folderId)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

getEmailFileEntryAddedBodyMap

Map<Locale,String> getEmailFileEntryAddedBodyMap(PortletPreferences preferences)

getEmailFileEntryAddedEnabled

boolean getEmailFileEntryAddedEnabled(PortletPreferences preferences)

getEmailFileEntryAddedSubjectMap

Map<Locale,String> getEmailFileEntryAddedSubjectMap(PortletPreferences preferences)

getEmailFileEntryUpdatedBodyMap

Map<Locale,String> getEmailFileEntryUpdatedBodyMap(PortletPreferences preferences)

getEmailFileEntryUpdatedEnabled

boolean getEmailFileEntryUpdatedEnabled(PortletPreferences preferences)

getEmailFileEntryUpdatedSubjectMap

Map<Locale,String> getEmailFileEntryUpdatedSubjectMap(PortletPreferences preferences)

getEmailFromAddress

String getEmailFromAddress(PortletPreferences preferences,
                           long companyId)
                           throws SystemException
Throws:
SystemException

getEmailFromName

String getEmailFromName(PortletPreferences preferences,
                        long companyId)
                        throws SystemException
Throws:
SystemException

getEntries

List<Object> getEntries(Hits hits)

getFileEntryImage

String getFileEntryImage(FileEntry fileEntry,
                         ThemeDisplay themeDisplay)

getFileEntryTypeSubscriptionClassPKs

Set<Long> getFileEntryTypeSubscriptionClassPKs(long userId)
                                               throws SystemException
Throws:
SystemException

getFileIcon

String getFileIcon(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,
                          ThemeDisplay themeDisplay)
                          throws Exception
Throws:
Exception

getMediaGalleryMimeTypes

String[] getMediaGalleryMimeTypes(PortletPreferences portletPreferences,
                                  PortletRequest portletRequest)

getPreviewURL

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

getPreviewURL

String getPreviewURL(FileEntry fileEntry,
                     FileVersion fileVersion,
                     ThemeDisplay themeDisplay,
                     String queryString,
                     boolean appendToken)
Deprecated. As of 6.2.0, replaced by getPreviewURL(FileEntry, FileVersion, ThemeDisplay, String, boolean, boolean)


getPreviewURL

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

getRepositoryModelOrderByComparator

OrderByComparator getRepositoryModelOrderByComparator(String orderByCol,
                                                      String orderByType)

getTempFileId

String getTempFileId(long id,
                     String version)

getTempFileId

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

getThumbnailSrc

String getThumbnailSrc(FileEntry fileEntry,
                       DLFileShortcut dlFileShortcut,
                       ThemeDisplay themeDisplay)
                       throws Exception
Throws:
Exception

getThumbnailSrc

String getThumbnailSrc(FileEntry fileEntry,
                       FileVersion fileVersion,
                       DLFileShortcut dlFileShortcut,
                       ThemeDisplay themeDisplay)
                       throws Exception
Throws:
Exception

getThumbnailStyle

String getThumbnailStyle()
                         throws Exception
Throws:
Exception

getThumbnailStyle

String getThumbnailStyle(boolean max,
                         int margin)
                         throws Exception
Throws:
Exception

getTitleWithExtension

String getTitleWithExtension(FileEntry fileEntry)

getTitleWithExtension

String getTitleWithExtension(String title,
                             String extension)

getWebDavURL

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

getWebDavURL

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

getWebDavURL

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 Exception
Throws:
Exception

isAutoGeneratedDLFileEntryTypeDDMStructureKey

boolean isAutoGeneratedDLFileEntryTypeDDMStructureKey(String ddmStructureKey)

isOfficeExtension

boolean isOfficeExtension(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(String version)

Liferay 6.2.0