com.liferay.portal.kernel.lar
Interface PortletDataContext

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
PortletDataContext

public interface PortletDataContext
extends java.io.Serializable

View Source

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

Author:
Brian Wing Shun Chan, Raymond Augé

Field Summary
static java.lang.String ROOT_PATH_GROUPS
           
static java.lang.String ROOT_PATH_LAYOUTS
           
static java.lang.String ROOT_PATH_PORTLETS
           
 
Method Summary
 void addAssetCategories(java.lang.Class<?> classObj, long classPK)
           
 void addAssetCategories(java.lang.String className, long classPK, long[] assetCategoryIds)
           
 void addAssetTags(java.lang.Class<?> classObj, long classPK)
           
 void addAssetTags(java.lang.String className, long classPK, java.lang.String[] assetTagNames)
           
 void addComments(java.lang.Class<?> classObj, long classPK)
           
 void addComments(java.lang.String className, long classPK, java.util.List<MBMessage> messages)
           
 void addLocks(java.lang.Class<?> classObj, java.lang.String key)
           
 void addLocks(java.lang.String className, java.lang.String key, Lock lock)
           
 void addPermissions(java.lang.Class<?> classObj, long classPK)
           
 void addPermissions(java.lang.String resourceName, long resourcePK)
           
 void addPermissions(java.lang.String resourceName, long resourcePK, java.util.List<KeyValuePair> permissions)
           
 boolean addPrimaryKey(java.lang.Class<?> classObj, java.lang.String primaryKey)
           
 void addRatingsEntries(java.lang.Class<?> classObj, long classPK)
           
 void addRatingsEntries(java.lang.String className, long classPK, java.util.List<RatingsEntry> ratingsEntries)
           
 void addZipEntry(java.lang.String path, byte[] bytes)
           
 void addZipEntry(java.lang.String path, java.io.InputStream is)
           
 void addZipEntry(java.lang.String path, java.lang.Object object)
           
 void addZipEntry(java.lang.String path, java.lang.String s)
           
 void addZipEntry(java.lang.String name, java.lang.StringBuilder sb)
           
 java.lang.Object fromXML(byte[] bytes)
           
 java.lang.Object fromXML(java.lang.String xml)
           
 long[] getAssetCategoryIds(java.lang.Class<?> classObj, long classPK)
           
 java.util.Map<java.lang.String,long[]> getAssetCategoryIdsMap()
           
 java.util.Map<java.lang.String,java.lang.String[]> getAssetCategoryUuidsMap()
           
 java.lang.String[] getAssetTagNames(java.lang.Class<?> classObj, long classPK)
           
 java.lang.String[] getAssetTagNames(java.lang.String className, long classPK)
           
 java.util.Map<java.lang.String,java.lang.String[]> getAssetTagNamesMap()
           
 boolean getBooleanParameter(java.lang.String namespace, java.lang.String name)
           
 java.lang.ClassLoader getClassLoader()
           
 java.util.Map<java.lang.String,java.util.List<MBMessage>> getComments()
           
 long getCompanyId()
           
 java.lang.String getDataStrategy()
           
 java.util.Date getEndDate()
           
 long getGroupId()
           
 java.lang.String getLayoutPath(long layoutId)
           
 java.util.Map<java.lang.String,Lock> getLocks()
           
 java.util.Map<?,?> getNewPrimaryKeysMap(java.lang.Class<?> classObj)
           
 long getOldPlid()
           
 java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
           
 java.util.Map<java.lang.String,java.util.List<KeyValuePair>> getPermissions()
           
 long getPlid()
           
 java.lang.String getPortletPath(java.lang.String portletId)
           
 java.util.Set<java.lang.String> getPrimaryKeys()
           
 java.util.Map<java.lang.String,java.util.List<RatingsEntry>> getRatingsEntries()
           
 java.lang.String getRootPath()
           
 long getScopeGroupId()
           
 long getScopeLayoutId()
           
 long getSourceGroupId()
           
 java.lang.String getSourceLayoutPath(long layoutId)
           
 java.lang.String getSourcePortletPath(java.lang.String portletId)
           
 java.lang.String getSourceRootPath()
           
 java.util.Date getStartDate()
           
 long getUserId(java.lang.String userUuid)
           
 UserIdStrategy getUserIdStrategy()
           
 java.util.List<java.lang.String> getZipEntries()
           
 byte[] getZipEntryAsByteArray(java.lang.String path)
           
 java.io.InputStream getZipEntryAsInputStream(java.lang.String path)
           
 java.lang.Object getZipEntryAsObject(java.lang.String path)
           
 java.lang.String getZipEntryAsString(java.lang.String path)
           
 java.util.List<java.lang.String> getZipFolderEntries()
           
 java.util.List<java.lang.String> getZipFolderEntries(java.lang.String path)
           
 ZipReader getZipReader()
           
 ZipWriter getZipWriter()
           
 boolean hasDateRange()
           
 boolean hasNotUniquePerLayout(java.lang.String dataKey)
           
 boolean hasPrimaryKey(java.lang.Class<?> classObj, java.lang.String primaryKey)
           
 void importComments(java.lang.Class<?> classObj, long classPK, long newClassPK, long groupId)
           
 void importLocks(java.lang.Class<?> classObj, java.lang.String key, java.lang.String newKey)
           
 void importPermissions(java.lang.Class<?> classObj, long classPK, long newClassPK)
           
 void importPermissions(java.lang.String resourceObj, long resourcePK, long newResourcePK)
           
 void importRatingsEntries(java.lang.Class<?> classObj, long classPK, long newClassPK)
           
 boolean isPathNotProcessed(java.lang.String path)
           
 boolean isPrivateLayout()
           
 boolean isWithinDateRange(java.util.Date modifiedDate)
           
 void putNotUniquePerLayout(java.lang.String dataKey)
           
 void setClassLoader(java.lang.ClassLoader classLoader)
           
 void setGroupId(long groupId)
           
 void setOldPlid(long oldPlid)
           
 void setPlid(long plid)
           
 void setPortetDataContextListener(PortletDataContextListener portletDataContextListener)
           
 void setPrivateLayout(boolean privateLayout)
           
 void setScopeGroupId(long scopeGroupId)
           
 void setScopeLayoutId(long scopeLayoutId)
           
 void setSourceGroupId(long sourceGroupId)
           
 java.lang.String toXML(java.lang.Object object)
           
 

Field Detail

ROOT_PATH_GROUPS

static final java.lang.String ROOT_PATH_GROUPS
See Also:
Constant Field Values

ROOT_PATH_LAYOUTS

static final java.lang.String ROOT_PATH_LAYOUTS
See Also:
Constant Field Values

ROOT_PATH_PORTLETS

static final java.lang.String ROOT_PATH_PORTLETS
See Also:
Constant Field Values
Method Detail

addAssetCategories

void addAssetCategories(java.lang.Class<?> classObj,
                        long classPK)
                        throws SystemException
Throws:
SystemException

addAssetCategories

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

addAssetTags

void addAssetTags(java.lang.Class<?> classObj,
                  long classPK)
                  throws SystemException
Throws:
SystemException

addAssetTags

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

addComments

void addComments(java.lang.Class<?> classObj,
                 long classPK)
                 throws SystemException
Throws:
SystemException

addComments

void addComments(java.lang.String className,
                 long classPK,
                 java.util.List<MBMessage> messages)

addLocks

void addLocks(java.lang.Class<?> classObj,
              java.lang.String key)
              throws PortalException,
                     SystemException
Throws:
PortalException
SystemException

addLocks

void addLocks(java.lang.String className,
              java.lang.String key,
              Lock lock)

addPermissions

void addPermissions(java.lang.Class<?> classObj,
                    long classPK)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

addPermissions

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

addPermissions

void addPermissions(java.lang.String resourceName,
                    long resourcePK,
                    java.util.List<KeyValuePair> permissions)

addPrimaryKey

boolean addPrimaryKey(java.lang.Class<?> classObj,
                      java.lang.String primaryKey)

addRatingsEntries

void addRatingsEntries(java.lang.Class<?> classObj,
                       long classPK)
                       throws SystemException
Throws:
SystemException

addRatingsEntries

void addRatingsEntries(java.lang.String className,
                       long classPK,
                       java.util.List<RatingsEntry> ratingsEntries)

addZipEntry

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

addZipEntry

void addZipEntry(java.lang.String path,
                 java.io.InputStream is)
                 throws SystemException
Throws:
SystemException

addZipEntry

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

addZipEntry

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

addZipEntry

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

fromXML

java.lang.Object fromXML(byte[] bytes)

fromXML

java.lang.Object fromXML(java.lang.String xml)

getAssetCategoryIds

long[] getAssetCategoryIds(java.lang.Class<?> classObj,
                           long classPK)

getAssetCategoryIdsMap

java.util.Map<java.lang.String,long[]> getAssetCategoryIdsMap()

getAssetCategoryUuidsMap

java.util.Map<java.lang.String,java.lang.String[]> getAssetCategoryUuidsMap()

getAssetTagNames

java.lang.String[] getAssetTagNames(java.lang.Class<?> classObj,
                                    long classPK)

getAssetTagNames

java.lang.String[] getAssetTagNames(java.lang.String className,
                                    long classPK)

getAssetTagNamesMap

java.util.Map<java.lang.String,java.lang.String[]> getAssetTagNamesMap()

getBooleanParameter

boolean getBooleanParameter(java.lang.String namespace,
                            java.lang.String name)

getClassLoader

java.lang.ClassLoader getClassLoader()

getComments

java.util.Map<java.lang.String,java.util.List<MBMessage>> getComments()

getCompanyId

long getCompanyId()

getDataStrategy

java.lang.String getDataStrategy()

getEndDate

java.util.Date getEndDate()

getGroupId

long getGroupId()

getLayoutPath

java.lang.String getLayoutPath(long layoutId)

getLocks

java.util.Map<java.lang.String,Lock> getLocks()

getNewPrimaryKeysMap

java.util.Map<?,?> getNewPrimaryKeysMap(java.lang.Class<?> classObj)

getOldPlid

long getOldPlid()

getParameterMap

java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

getPermissions

java.util.Map<java.lang.String,java.util.List<KeyValuePair>> getPermissions()

getPlid

long getPlid()

getPortletPath

java.lang.String getPortletPath(java.lang.String portletId)

getPrimaryKeys

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

getRatingsEntries

java.util.Map<java.lang.String,java.util.List<RatingsEntry>> getRatingsEntries()

getRootPath

java.lang.String getRootPath()

getScopeGroupId

long getScopeGroupId()

getScopeLayoutId

long getScopeLayoutId()

getSourceGroupId

long getSourceGroupId()

getSourceLayoutPath

java.lang.String getSourceLayoutPath(long layoutId)

getSourcePortletPath

java.lang.String getSourcePortletPath(java.lang.String portletId)

getSourceRootPath

java.lang.String getSourceRootPath()

getStartDate

java.util.Date getStartDate()

getUserId

long getUserId(java.lang.String userUuid)
               throws SystemException
Throws:
SystemException

getUserIdStrategy

UserIdStrategy getUserIdStrategy()
                                 throws SystemException
Throws:
SystemException

getZipEntries

java.util.List<java.lang.String> getZipEntries()

getZipEntryAsByteArray

byte[] getZipEntryAsByteArray(java.lang.String path)

getZipEntryAsInputStream

java.io.InputStream getZipEntryAsInputStream(java.lang.String path)

getZipEntryAsObject

java.lang.Object getZipEntryAsObject(java.lang.String path)

getZipEntryAsString

java.lang.String getZipEntryAsString(java.lang.String path)

getZipFolderEntries

java.util.List<java.lang.String> getZipFolderEntries()

getZipFolderEntries

java.util.List<java.lang.String> getZipFolderEntries(java.lang.String path)

getZipReader

ZipReader getZipReader()

getZipWriter

ZipWriter getZipWriter()

hasDateRange

boolean hasDateRange()

hasNotUniquePerLayout

boolean hasNotUniquePerLayout(java.lang.String dataKey)

hasPrimaryKey

boolean hasPrimaryKey(java.lang.Class<?> classObj,
                      java.lang.String primaryKey)

importComments

void importComments(java.lang.Class<?> classObj,
                    long classPK,
                    long newClassPK,
                    long groupId)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

importLocks

void importLocks(java.lang.Class<?> classObj,
                 java.lang.String key,
                 java.lang.String newKey)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

importPermissions

void importPermissions(java.lang.Class<?> classObj,
                       long classPK,
                       long newClassPK)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

importPermissions

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

importRatingsEntries

void importRatingsEntries(java.lang.Class<?> classObj,
                          long classPK,
                          long newClassPK)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

isPathNotProcessed

boolean isPathNotProcessed(java.lang.String path)

isPrivateLayout

boolean isPrivateLayout()

isWithinDateRange

boolean isWithinDateRange(java.util.Date modifiedDate)

putNotUniquePerLayout

void putNotUniquePerLayout(java.lang.String dataKey)

setClassLoader

void setClassLoader(java.lang.ClassLoader classLoader)

setGroupId

void setGroupId(long groupId)

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)

setScopeLayoutId

void setScopeLayoutId(long scopeLayoutId)

setSourceGroupId

void setSourceGroupId(long sourceGroupId)

toXML

java.lang.String toXML(java.lang.Object object)