com.liferay.portlet.documentlibrary.lar
Class DLPortletDataHandlerImpl
java.lang.Object
com.liferay.portal.kernel.lar.BasePortletDataHandler
com.liferay.portlet.documentlibrary.lar.DLPortletDataHandlerImpl
- All Implemented Interfaces:
- PortletDataHandler
public class DLPortletDataHandlerImpl
- extends BasePortletDataHandler
|
Method Summary |
protected PortletPreferences |
doDeleteData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences)
|
protected String |
doExportData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences)
|
protected PortletPreferences |
doImportData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences,
String data)
|
static void |
exportFileEntry(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
Element foldersElement,
Element fileEntriesElement,
Element fileRanksElement,
FileEntry fileEntry,
boolean checkDateRange)
|
protected static void |
exportFileEntryType(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
DLFileEntryType dlFileEntryType)
|
protected static void |
exportFileRank(PortletDataContext portletDataContext,
Element fileRanksElement,
DLFileRank fileRank)
|
protected static void |
exportFileShortcut(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
Element foldersElement,
Element fileShortcutsElement,
DLFileShortcut fileShortcut)
|
protected static void |
exportFolder(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
Element foldersElement,
Element fileEntriesElement,
Element fileShortcutsElement,
Element fileRanksElement,
Folder folder,
boolean recurse)
|
protected static void |
exportFolderFileEntryTypes(PortletDataContext portletDataContext,
Folder folder,
Element fileEntryTypesElement,
Element folderElement)
|
protected static void |
exportMetaData(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
Element fileEntryElement,
FileEntry fileEntry)
|
protected static void |
exportParentFolder(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
Element foldersElement,
long folderId)
|
PortletDataHandlerControl[] |
getExportControls()
Returns an array of the controls defined for this data handler. |
protected static String |
getFileEntryBinPath(PortletDataContext portletDataContext,
FileEntry fileEntry)
|
protected static String |
getFileEntryFileEntryTypeStructureFieldsPath(PortletDataContext portletDataContext,
FileEntry fileEntry,
String fileEntryTypeUuid,
long structureId)
|
static String |
getFileEntryPath(PortletDataContext portletDataContext,
FileEntry fileEntry)
|
protected static String |
getFileEntryTypeName(String uuid,
long companyId,
long groupId,
String name,
int count)
|
protected static String |
getFileEntryTypePath(PortletDataContext portletDataContext,
DLFileEntryType dlFileEntryType)
|
protected static String |
getFileRankPath(PortletDataContext portletDataContext,
DLFileRank fileRank)
|
protected static String |
getFileShortcutPath(PortletDataContext portletDataContext,
DLFileShortcut fileShortcut)
|
protected static String |
getFolderName(String uuid,
long companyId,
long groupId,
long parentFolderId,
String name,
int count)
|
protected static String |
getFolderPath(PortletDataContext portletDataContext,
Folder folder)
|
PortletDataHandlerControl[] |
getImportControls()
Returns an array of the controls defined for this data handler. |
protected static String |
getImportFolderPath(PortletDataContext portletDataContext,
long folderId)
|
static void |
importFileEntry(PortletDataContext portletDataContext,
Element fileEntryElement)
|
protected static void |
importFileEntryType(PortletDataContext portletDataContext,
Element fileEntryTypeElement)
|
protected static void |
importFileRank(PortletDataContext portletDataContext,
DLFileRank fileRank,
String fileEntryUuid)
|
static void |
importFileRank(PortletDataContext portletDataContext,
Element fileRankElement)
|
protected static void |
importFileShortcut(PortletDataContext portletDataContext,
Element fileShortcutElement)
|
protected static void |
importFileShortcut(PortletDataContext portletDataContext,
Element fileShortcutElement,
DLFileShortcut fileShortcut)
|
static void |
importFolder(PortletDataContext portletDataContext,
Element folderElement)
|
protected static void |
importFolder(PortletDataContext portletDataContext,
String folderPath,
Element folderElement,
Folder folder)
|
protected static void |
importFolderFileEntryTypes(PortletDataContext portletDataContext,
Element folderElement,
Folder folder,
ServiceContext serviceContext)
|
protected static void |
importMetaData(PortletDataContext portletDataContext,
Element fileEntryElement,
ServiceContext serviceContext)
|
boolean |
isAlwaysExportable()
Returns true to allow the user to export data for this
portlet even though it may not belong to any pages. |
protected static boolean |
isDuplicateFileEntry(String folderUuid,
FileEntry fileEntry1,
FileEntry fileEntry2)
|
protected static boolean |
isFileEntryTypeExportable(long companyId,
DLFileEntryType dlFileEntryType)
|
boolean |
isPublishToLiveByDefault()
Returns whether the data exported by this handler should be included by
default when publishing to live. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DLPortletDataHandlerImpl
public DLPortletDataHandlerImpl()
exportFileEntry
public static void exportFileEntry(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
Element foldersElement,
Element fileEntriesElement,
Element fileRanksElement,
FileEntry fileEntry,
boolean checkDateRange)
throws Exception
- Throws:
Exception
getFileEntryPath
public static String getFileEntryPath(PortletDataContext portletDataContext,
FileEntry fileEntry)
importFileEntry
public static void importFileEntry(PortletDataContext portletDataContext,
Element fileEntryElement)
throws Exception
- Throws:
Exception
importFileRank
public static void importFileRank(PortletDataContext portletDataContext,
Element fileRankElement)
throws Exception
- Throws:
Exception
importFolder
public static void importFolder(PortletDataContext portletDataContext,
Element folderElement)
throws Exception
- Throws:
Exception
getExportControls
public PortletDataHandlerControl[] getExportControls()
- Description copied from interface:
PortletDataHandler
- Returns an array of the controls defined for this data handler. These
controls enable the developer to create fine grained controls over export
behavior. The controls are rendered in the export UI.
- Specified by:
getExportControls in interface PortletDataHandler- Overrides:
getExportControls in class BasePortletDataHandler
- Returns:
- an array of PortletDataHandlerControls
getImportControls
public PortletDataHandlerControl[] getImportControls()
- Description copied from interface:
PortletDataHandler
- Returns an array of the controls defined for this data handler. These
controls enable the developer to create fine grained controls over import
behavior. The controls are rendered in the import UI.
- Specified by:
getImportControls in interface PortletDataHandler- Overrides:
getImportControls in class BasePortletDataHandler
- Returns:
- An array of PortletDataHandlerControls
isAlwaysExportable
public boolean isAlwaysExportable()
- Description copied from interface:
PortletDataHandler
- Returns
true to allow the user to export data for this
portlet even though it may not belong to any pages. See LPS-1624.
- Specified by:
isAlwaysExportable in interface PortletDataHandler- Overrides:
isAlwaysExportable in class BasePortletDataHandler
- Returns:
true to allow the user to export data for this
portlet even though it may not belong to any pages
isPublishToLiveByDefault
public boolean isPublishToLiveByDefault()
- Description copied from interface:
PortletDataHandler
- Returns whether the data exported by this handler should be included by
default when publishing to live. This should only be
true
for data that is meant to be managed in an staging environment such as
CMS content, but not for data meant to be input by users such as wiki
pages or message board posts.
- Specified by:
isPublishToLiveByDefault in interface PortletDataHandler- Overrides:
isPublishToLiveByDefault in class BasePortletDataHandler
- Returns:
true to publish to live by default
exportFileEntryType
protected static void exportFileEntryType(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
DLFileEntryType dlFileEntryType)
throws Exception
- Throws:
Exception
exportFileRank
protected static void exportFileRank(PortletDataContext portletDataContext,
Element fileRanksElement,
DLFileRank fileRank)
throws Exception
- Throws:
Exception
exportFileShortcut
protected static void exportFileShortcut(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
Element foldersElement,
Element fileShortcutsElement,
DLFileShortcut fileShortcut)
throws Exception
- Throws:
Exception
exportFolder
protected static void exportFolder(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
Element foldersElement,
Element fileEntriesElement,
Element fileShortcutsElement,
Element fileRanksElement,
Folder folder,
boolean recurse)
throws Exception
- Throws:
Exception
exportFolderFileEntryTypes
protected static void exportFolderFileEntryTypes(PortletDataContext portletDataContext,
Folder folder,
Element fileEntryTypesElement,
Element folderElement)
throws Exception
- Throws:
Exception
exportMetaData
protected static void exportMetaData(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
Element fileEntryElement,
FileEntry fileEntry)
throws Exception
- Throws:
Exception
exportParentFolder
protected static void exportParentFolder(PortletDataContext portletDataContext,
Element fileEntryTypesElement,
Element foldersElement,
long folderId)
throws Exception
- Throws:
Exception
getFileEntryBinPath
protected static String getFileEntryBinPath(PortletDataContext portletDataContext,
FileEntry fileEntry)
getFileEntryFileEntryTypeStructureFieldsPath
protected static String getFileEntryFileEntryTypeStructureFieldsPath(PortletDataContext portletDataContext,
FileEntry fileEntry,
String fileEntryTypeUuid,
long structureId)
getFileEntryTypeName
protected static String getFileEntryTypeName(String uuid,
long companyId,
long groupId,
String name,
int count)
throws Exception
- Throws:
Exception
getFileEntryTypePath
protected static String getFileEntryTypePath(PortletDataContext portletDataContext,
DLFileEntryType dlFileEntryType)
getFileRankPath
protected static String getFileRankPath(PortletDataContext portletDataContext,
DLFileRank fileRank)
getFileShortcutPath
protected static String getFileShortcutPath(PortletDataContext portletDataContext,
DLFileShortcut fileShortcut)
getFolderName
protected static String getFolderName(String uuid,
long companyId,
long groupId,
long parentFolderId,
String name,
int count)
throws Exception
- Throws:
Exception
getFolderPath
protected static String getFolderPath(PortletDataContext portletDataContext,
Folder folder)
getImportFolderPath
protected static String getImportFolderPath(PortletDataContext portletDataContext,
long folderId)
importFileEntryType
protected static void importFileEntryType(PortletDataContext portletDataContext,
Element fileEntryTypeElement)
throws Exception
- Throws:
Exception
importFileRank
protected static void importFileRank(PortletDataContext portletDataContext,
DLFileRank fileRank,
String fileEntryUuid)
throws Exception
- Throws:
Exception
importFileShortcut
protected static void importFileShortcut(PortletDataContext portletDataContext,
Element fileShortcutElement)
throws Exception
- Throws:
Exception
importFileShortcut
protected static void importFileShortcut(PortletDataContext portletDataContext,
Element fileShortcutElement,
DLFileShortcut fileShortcut)
throws Exception
- Throws:
Exception
importFolder
protected static void importFolder(PortletDataContext portletDataContext,
String folderPath,
Element folderElement,
Folder folder)
throws Exception
- Throws:
Exception
importFolderFileEntryTypes
protected static void importFolderFileEntryTypes(PortletDataContext portletDataContext,
Element folderElement,
Folder folder,
ServiceContext serviceContext)
throws Exception
- Throws:
Exception
importMetaData
protected static void importMetaData(PortletDataContext portletDataContext,
Element fileEntryElement,
ServiceContext serviceContext)
throws Exception
- Throws:
Exception
isDuplicateFileEntry
protected static boolean isDuplicateFileEntry(String folderUuid,
FileEntry fileEntry1,
FileEntry fileEntry2)
isFileEntryTypeExportable
protected static boolean isFileEntryTypeExportable(long companyId,
DLFileEntryType dlFileEntryType)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
doDeleteData
protected PortletPreferences doDeleteData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences)
throws Exception
- Overrides:
doDeleteData in class BasePortletDataHandler
- Throws:
Exception
doExportData
protected String doExportData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences)
throws Exception
- Overrides:
doExportData in class BasePortletDataHandler
- Throws:
Exception
doImportData
protected PortletPreferences doImportData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences,
String data)
throws Exception
- Overrides:
doImportData in class BasePortletDataHandler
- Throws:
Exception