Liferay 6.2.0-ce-m5

com.liferay.portal.kernel.lar
Interface PortletDataContext

All Superinterfaces:
Serializable
All Known Subinterfaces:
PortletDataContext
All Known Implementing Classes:
PortletDataContextImpl

public interface PortletDataContext
extends Serializable

Holds context information that is used during exporting and importing portlet data.


Field Summary
static String ROOT_PATH_GROUPS
          Deprecated. As of 6.2.0, replaced by ExportImportPathUtil._PATH_PREFIX_GROUP
static String ROOT_PATH_LAYOUTS
          Deprecated. As of 6.2.0, replaced by ExportImportPathUtil._PATH_PREFIX_LAYOUT
static String ROOT_PATH_PORTLETS
          Deprecated. As of 6.2.0, replaced by ExportImportPathUtil._PATH_PREFIX_PORTLET
 
Method Summary
 void addAssetCategories(Class<?> clazz, long classPK)
           
 void addAssetCategories(String className, long classPK, long[] assetCategoryIds)
           
 void addAssetTags(Class<?> clazz, long classPK)
           
 void addAssetTags(String className, long classPK, String[] assetTagNames)
           
 void addClassedModel(Element element, String path, ClassedModel classedModel, String namespace)
           
 void addComments(Class<?> clazz, long classPK)
           
 void addComments(String className, long classPK, List<MBMessage> messages)
           
 void addDateRangeCriteria(DynamicQuery dynamicQuery, String modifiedDatePropertyName)
           
 void addExpando(Element element, String path, ClassedModel classedModel)
           
 void addLocks(Class<?> clazz, String key)
           
 void addLocks(String className, String key, Lock lock)
           
 void addPermissions(Class<?> clazz, long classPK)
           
 void addPermissions(String resourceName, long resourcePK)
           
 void addPermissions(String resourceName, long resourcePK, List<KeyValuePair> permissions)
           
 boolean addPrimaryKey(Class<?> clazz, String primaryKey)
           
 void addRatingsEntries(Class<?> clazz, long classPK)
           
 void addRatingsEntries(String className, long classPK, List<RatingsEntry> ratingsEntries)
           
 Element addReferenceElement(Element element, ClassedModel referencedClassedModel)
           
 void addZipEntry(String path, byte[] bytes)
           
 void addZipEntry(String path, InputStream is)
           
 void addZipEntry(String path, Object object)
           
 void addZipEntry(String path, String s)
           
 void addZipEntry(String name, StringBuilder sb)
           
 ServiceContext createServiceContext(Element element, ClassedModel classedModel, String namespace)
           
 ServiceContext createServiceContext(StagedModel stagedModel, String namespace)
           
 ServiceContext createServiceContext(String path, ClassedModel classedModel, String namespace)
           
 Object fromXML(byte[] bytes)
           
 Object fromXML(String xml)
           
 long[] getAssetCategoryIds(Class<?> clazz, long classPK)
           
 Map<String,long[]> getAssetCategoryIdsMap()
           
 Map<String,String[]> getAssetCategoryUuidsMap()
           
 Map<String,String[]> getAssetLinkUuidsMap()
           
 String[] getAssetTagNames(Class<?> clazz, long classPK)
           
 String[] getAssetTagNames(String className, long classPK)
           
 Map<String,String[]> getAssetTagNamesMap()
           
 boolean getBooleanParameter(String namespace, String name)
           
 ClassLoader getClassLoader()
           
 Map<String,List<MBMessage>> getComments()
           
 long getCompanyGroupId()
           
 long getCompanyId()
           
 String getDataStrategy()
           
 Date getEndDate()
           
 Map<String,List<ExpandoColumn>> getExpandoColumns()
           
 Element getExportDataGroupElement(Class<? extends StagedModel> clazz)
           
 Element getExportDataRootElement()
           
 Element getExportDataStagedModelElement(StagedModel stagedModel)
           
 long getGroupId()
           
 Element getImportDataGroupElement(Class<? extends StagedModel> clazz)
           
 Element getImportDataRootElement()
           
 Element getImportDataStagedModelElement(StagedModel stagedModel)
           
 Element getImportDataStagedModelElement(String name, String attribute, String value)
           
 String getLayoutPath(long layoutId)
          Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getLayoutPath(PortletDataContext, long)
 Map<String,Lock> getLocks()
           
 Map<?,?> getNewPrimaryKeysMap(Class<?> clazz)
           
 Map<?,?> getNewPrimaryKeysMap(String className)
           
 long getOldPlid()
           
 Map<String,String[]> getParameterMap()
           
 Map<String,List<KeyValuePair>> getPermissions()
           
 long getPlid()
           
 String getPortletPath(String portletId)
          Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getPortletPath(PortletDataContext, String)
 Set<String> getPrimaryKeys()
           
 Map<String,List<RatingsEntry>> getRatingsEntries()
           
 List<Element> getReferencedDataElements(StagedModel parentStagedModel, Class<? extends StagedModel> clazz)
           
 String getRootPath()
          Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getRootPath(PortletDataContext)
 long getScopeGroupId()
           
 String getScopeLayoutUuid()
           
 String getScopeType()
           
 long getSourceCompanyGroupId()
           
 long getSourceGroupId()
           
 String getSourceLayoutPath(long layoutId)
          Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getSourceLayoutPath(PortletDataContext, long)
 String getSourcePortletPath(String portletId)
          Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getSourcePortletPath( PortletDataContext, String)
 String getSourceRootPath()
          Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getSourceRootPath(PortletDataContext)
 Date getStartDate()
           
 long getUserId(String userUuid)
           
 UserIdStrategy getUserIdStrategy()
           
 List<String> getZipEntries()
           
 byte[] getZipEntryAsByteArray(String path)
           
 InputStream getZipEntryAsInputStream(String path)
           
 Object getZipEntryAsObject(Element element, String path)
           
 Object getZipEntryAsObject(String path)
           
 String getZipEntryAsString(String path)
           
 List<String> getZipFolderEntries()
           
 List<String> getZipFolderEntries(String path)
           
 ZipReader getZipReader()
           
 ZipWriter getZipWriter()
           
 boolean hasDateRange()
           
 boolean hasNotUniquePerLayout(String dataKey)
           
 boolean hasPrimaryKey(Class<?> clazz, String primaryKey)
           
 void importClassedModel(ClassedModel classedModel, ClassedModel newClassedModel, String namespace)
           
 void importComments(Class<?> clazz, long classPK, long newClassPK, long groupId)
           
 void importLocks(Class<?> clazz, String key, String newKey)
           
 void importPermissions(Class<?> clazz, long classPK, long newClassPK)
           
 void importPermissions(String resourceObj, long resourcePK, long newResourcePK)
           
 void importRatingsEntries(Class<?> clazz, long classPK, long newClassPK)
           
 boolean isDataStrategyMirror()
           
 boolean isDataStrategyMirrorWithOverwriting()
           
 boolean isPathNotProcessed(String path)
           
 boolean isPathProcessed(String path)
           
 boolean isPerformDirectBinaryImport()
           
 boolean isPrivateLayout()
           
 boolean isWithinDateRange(Date modifiedDate)
           
 void putNotUniquePerLayout(String dataKey)
           
 void setClassLoader(ClassLoader classLoader)
           
 void setExportDataRootElement(Element exportDataRootElement)
           
 void setGroupId(long groupId)
           
 void setImportDataRootElement(Element importDataRootElement)
           
 void setOldPlid(long oldPlid)
           
 void setPlid(long plid)
           
 void setPortetDataContextListener(PortletDataContextListener portletDataContextListener)
           
 void setPrivateLayout(boolean privateLayout)
           
 void setScopeGroupId(long scopeGroupId)
           
 void setScopeLayoutUuid(String scopeLayoutUuid)
           
 void setScopeType(String scopeType)
           
 void setSourceCompanyGroupId(long sourceCompanyGroupId)
           
 void setSourceGroupId(long sourceGroupId)
           
 void setStartDate(Date startDate)
           
 String toXML(Object object)
           
 

Field Detail

ROOT_PATH_GROUPS

static final String ROOT_PATH_GROUPS
Deprecated. As of 6.2.0, replaced by ExportImportPathUtil._PATH_PREFIX_GROUP
See Also:
Constant Field Values

ROOT_PATH_LAYOUTS

static final String ROOT_PATH_LAYOUTS
Deprecated. As of 6.2.0, replaced by ExportImportPathUtil._PATH_PREFIX_LAYOUT
See Also:
Constant Field Values

ROOT_PATH_PORTLETS

static final String ROOT_PATH_PORTLETS
Deprecated. As of 6.2.0, replaced by ExportImportPathUtil._PATH_PREFIX_PORTLET
See Also:
Constant Field Values
Method Detail

addAssetCategories

void addAssetCategories(Class<?> clazz,
                        long classPK)
                        throws SystemException
Throws:
SystemException

addAssetCategories

void addAssetCategories(String className,
                        long classPK,
                        long[] assetCategoryIds)

addAssetTags

void addAssetTags(Class<?> clazz,
                  long classPK)
                  throws SystemException
Throws:
SystemException

addAssetTags

void addAssetTags(String className,
                  long classPK,
                  String[] assetTagNames)

addClassedModel

void addClassedModel(Element element,
                     String path,
                     ClassedModel classedModel,
                     String namespace)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

addComments

void addComments(Class<?> clazz,
                 long classPK)
                 throws SystemException
Throws:
SystemException

addComments

void addComments(String className,
                 long classPK,
                 List<MBMessage> messages)

addDateRangeCriteria

void addDateRangeCriteria(DynamicQuery dynamicQuery,
                          String modifiedDatePropertyName)

addExpando

void addExpando(Element element,
                String path,
                ClassedModel classedModel)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

addLocks

void addLocks(Class<?> clazz,
              String key)
              throws PortalException,
                     SystemException
Throws:
PortalException
SystemException

addLocks

void addLocks(String className,
              String key,
              Lock lock)

addPermissions

void addPermissions(Class<?> clazz,
                    long classPK)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

addPermissions

void addPermissions(String resourceName,
                    long resourcePK)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

addPermissions

void addPermissions(String resourceName,
                    long resourcePK,
                    List<KeyValuePair> permissions)

addPrimaryKey

boolean addPrimaryKey(Class<?> clazz,
                      String primaryKey)

addRatingsEntries

void addRatingsEntries(Class<?> clazz,
                       long classPK)
                       throws SystemException
Throws:
SystemException

addRatingsEntries

void addRatingsEntries(String className,
                       long classPK,
                       List<RatingsEntry> ratingsEntries)

addReferenceElement

Element addReferenceElement(Element element,
                            ClassedModel referencedClassedModel)

addZipEntry

void addZipEntry(String path,
                 byte[] bytes)
                 throws SystemException
Throws:
SystemException

addZipEntry

void addZipEntry(String path,
                 InputStream is)
                 throws SystemException
Throws:
SystemException

addZipEntry

void addZipEntry(String path,
                 Object object)
                 throws SystemException
Throws:
SystemException

addZipEntry

void addZipEntry(String path,
                 String s)
                 throws SystemException
Throws:
SystemException

addZipEntry

void addZipEntry(String name,
                 StringBuilder sb)
                 throws SystemException
Throws:
SystemException

createServiceContext

ServiceContext createServiceContext(Element element,
                                    ClassedModel classedModel,
                                    String namespace)

createServiceContext

ServiceContext createServiceContext(StagedModel stagedModel,
                                    String namespace)

createServiceContext

ServiceContext createServiceContext(String path,
                                    ClassedModel classedModel,
                                    String namespace)

fromXML

Object fromXML(byte[] bytes)

fromXML

Object fromXML(String xml)

getAssetCategoryIds

long[] getAssetCategoryIds(Class<?> clazz,
                           long classPK)

getAssetCategoryIdsMap

Map<String,long[]> getAssetCategoryIdsMap()

getAssetCategoryUuidsMap

Map<String,String[]> getAssetCategoryUuidsMap()

getAssetLinkUuidsMap

Map<String,String[]> getAssetLinkUuidsMap()

getAssetTagNames

String[] getAssetTagNames(Class<?> clazz,
                          long classPK)

getAssetTagNames

String[] getAssetTagNames(String className,
                          long classPK)

getAssetTagNamesMap

Map<String,String[]> getAssetTagNamesMap()

getBooleanParameter

boolean getBooleanParameter(String namespace,
                            String name)

getClassLoader

ClassLoader getClassLoader()

getComments

Map<String,List<MBMessage>> getComments()

getCompanyGroupId

long getCompanyGroupId()

getCompanyId

long getCompanyId()

getDataStrategy

String getDataStrategy()

getEndDate

Date getEndDate()

getExpandoColumns

Map<String,List<ExpandoColumn>> getExpandoColumns()

getExportDataGroupElement

Element getExportDataGroupElement(Class<? extends StagedModel> clazz)

getExportDataRootElement

Element getExportDataRootElement()

getExportDataStagedModelElement

Element getExportDataStagedModelElement(StagedModel stagedModel)

getGroupId

long getGroupId()

getImportDataGroupElement

Element getImportDataGroupElement(Class<? extends StagedModel> clazz)

getImportDataRootElement

Element getImportDataRootElement()

getImportDataStagedModelElement

Element getImportDataStagedModelElement(StagedModel stagedModel)

getImportDataStagedModelElement

Element getImportDataStagedModelElement(String name,
                                        String attribute,
                                        String value)

getLayoutPath

String getLayoutPath(long layoutId)
Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getLayoutPath(PortletDataContext, long)


getLocks

Map<String,Lock> getLocks()

getNewPrimaryKeysMap

Map<?,?> getNewPrimaryKeysMap(Class<?> clazz)

getNewPrimaryKeysMap

Map<?,?> getNewPrimaryKeysMap(String className)

getOldPlid

long getOldPlid()

getParameterMap

Map<String,String[]> getParameterMap()

getPermissions

Map<String,List<KeyValuePair>> getPermissions()

getPlid

long getPlid()

getPortletPath

String getPortletPath(String portletId)
Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getPortletPath(PortletDataContext, String)


getPrimaryKeys

Set<String> getPrimaryKeys()

getRatingsEntries

Map<String,List<RatingsEntry>> getRatingsEntries()

getReferencedDataElements

List<Element> getReferencedDataElements(StagedModel parentStagedModel,
                                        Class<? extends StagedModel> clazz)

getRootPath

String getRootPath()
Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getRootPath(PortletDataContext)


getScopeGroupId

long getScopeGroupId()

getScopeLayoutUuid

String getScopeLayoutUuid()

getScopeType

String getScopeType()

getSourceCompanyGroupId

long getSourceCompanyGroupId()

getSourceGroupId

long getSourceGroupId()

getSourceLayoutPath

String getSourceLayoutPath(long layoutId)
Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getSourceLayoutPath(PortletDataContext, long)


getSourcePortletPath

String getSourcePortletPath(String portletId)
Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getSourcePortletPath( PortletDataContext, String)


getSourceRootPath

String getSourceRootPath()
Deprecated. As of 6.2.0, replaced by ExportImportPathUtil.getSourceRootPath(PortletDataContext)


getStartDate

Date getStartDate()

getUserId

long getUserId(String userUuid)
               throws SystemException
Throws:
SystemException

getUserIdStrategy

UserIdStrategy getUserIdStrategy()

getZipEntries

List<String> getZipEntries()

getZipEntryAsByteArray

byte[] getZipEntryAsByteArray(String path)

getZipEntryAsInputStream

InputStream getZipEntryAsInputStream(String path)

getZipEntryAsObject

Object getZipEntryAsObject(Element element,
                           String path)

getZipEntryAsObject

Object getZipEntryAsObject(String path)

getZipEntryAsString

String getZipEntryAsString(String path)

getZipFolderEntries

List<String> getZipFolderEntries()

getZipFolderEntries

List<String> getZipFolderEntries(String path)

getZipReader

ZipReader getZipReader()

getZipWriter

ZipWriter getZipWriter()

hasDateRange

boolean hasDateRange()

hasNotUniquePerLayout

boolean hasNotUniquePerLayout(String dataKey)

hasPrimaryKey

boolean hasPrimaryKey(Class<?> clazz,
                      String primaryKey)

importClassedModel

void importClassedModel(ClassedModel classedModel,
                        ClassedModel newClassedModel,
                        String namespace)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

importComments

void importComments(Class<?> clazz,
                    long classPK,
                    long newClassPK,
                    long groupId)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

importLocks

void importLocks(Class<?> clazz,
                 String key,
                 String newKey)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

importPermissions

void importPermissions(Class<?> clazz,
                       long classPK,
                       long newClassPK)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

importPermissions

void importPermissions(String resourceObj,
                       long resourcePK,
                       long newResourcePK)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

importRatingsEntries

void importRatingsEntries(Class<?> clazz,
                          long classPK,
                          long newClassPK)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

isDataStrategyMirror

boolean isDataStrategyMirror()

isDataStrategyMirrorWithOverwriting

boolean isDataStrategyMirrorWithOverwriting()

isPathNotProcessed

boolean isPathNotProcessed(String path)

isPathProcessed

boolean isPathProcessed(String path)

isPerformDirectBinaryImport

boolean isPerformDirectBinaryImport()

isPrivateLayout

boolean isPrivateLayout()

isWithinDateRange

boolean isWithinDateRange(Date modifiedDate)

putNotUniquePerLayout

void putNotUniquePerLayout(String dataKey)

setClassLoader

void setClassLoader(ClassLoader classLoader)

setExportDataRootElement

void setExportDataRootElement(Element exportDataRootElement)

setGroupId

void setGroupId(long groupId)

setImportDataRootElement

void setImportDataRootElement(Element importDataRootElement)

setOldPlid

void setOldPlid(long oldPlid)

setPlid

void setPlid(long plid)

setPortetDataContextListener

void setPortetDataContextListener(PortletDataContextListener portletDataContextListener)

setPrivateLayout

void setPrivateLayout(boolean privateLayout)

setScopeGroupId

void setScopeGroupId(long scopeGroupId)

setScopeLayoutUuid

void setScopeLayoutUuid(String scopeLayoutUuid)

setScopeType

void setScopeType(String scopeType)

setSourceCompanyGroupId

void setSourceCompanyGroupId(long sourceCompanyGroupId)

setSourceGroupId

void setSourceGroupId(long sourceGroupId)

setStartDate

void setStartDate(Date startDate)

toXML

String toXML(Object object)

Liferay 6.2.0-ce-m5