Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.lar
Interface PortletDataContext

All Superinterfaces:
java.io.Serializable
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 addComments(java.lang.Class<?> classObj, long classPK)
           
 void addComments(java.lang.String className, long classPK, java.util.List<MBMessage> messages)
           
 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 addTagsCategories(java.lang.Class<?> classObj, long classPK)
           
 void addTagsCategories(java.lang.String className, long classPK, java.lang.String[] tagsCategories)
           
 void addTagsEntries(java.lang.Class<?> classObj, long classPK)
           
 void addTagsEntries(java.lang.String className, long classPK, java.lang.String[] tagsEntries)
           
 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)
           
 boolean getBooleanParameter(java.lang.String namespace, java.lang.String name)
           
 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<?,?> getNewPrimaryKeysMap(java.lang.Class<?> classObj)
           
 long getOldPlid()
           
 java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
           
 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()
           
 java.util.Map<java.lang.String,java.lang.String[]> getTagsCategories()
           
 java.lang.String[] getTagsCategories(java.lang.Class<?> classObj, long classPK)
           
 java.util.Map<java.lang.String,java.lang.String[]> getTagsEntries()
           
 java.lang.String[] getTagsEntries(java.lang.Class<?> classObj, long classPK)
           
 java.lang.String[] getTagsEntries(java.lang.String className, long classPK)
           
 long getUserId(java.lang.String userUuid)
           
 UserIdStrategy getUserIdStrategy()
           
 java.util.Map<java.lang.String,byte[]> getZipEntries()
           
 byte[] getZipEntryAsByteArray(java.lang.String path)
           
 java.lang.Object getZipEntryAsObject(java.lang.String path)
           
 java.lang.String getZipEntryAsString(java.lang.String path)
           
 java.util.Map<java.lang.String,java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>>> getZipFolderEntries()
           
 java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> getZipFolderEntries(java.lang.String path)
           
 com.liferay.portal.kernel.zip.ZipReader getZipReader()
           
 com.liferay.portal.kernel.zip.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 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 setGroupId(long groupId)
           
 void setOldPlid(long oldPlid)
           
 void setPlid(long plid)
           
 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

addComments

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

addComments

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

addPrimaryKey

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

addRatingsEntries

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

addRatingsEntries

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

addTagsCategories

void addTagsCategories(java.lang.Class<?> classObj,
                       long classPK)
                       throws com.liferay.portal.PortalException,
                              com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addTagsCategories

void addTagsCategories(java.lang.String className,
                       long classPK,
                       java.lang.String[] tagsCategories)

addTagsEntries

void addTagsEntries(java.lang.Class<?> classObj,
                    long classPK)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addTagsEntries

void addTagsEntries(java.lang.String className,
                    long classPK,
                    java.lang.String[] tagsEntries)

addZipEntry

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

addZipEntry

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

addZipEntry

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

addZipEntry

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

addZipEntry

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

fromXML

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

fromXML

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

getBooleanParameter

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

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)

getNewPrimaryKeysMap

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

getOldPlid

long getOldPlid()

getParameterMap

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

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()

getTagsCategories

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

getTagsCategories

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

getTagsEntries

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

getTagsEntries

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

getTagsEntries

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

getUserId

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

getUserIdStrategy

UserIdStrategy getUserIdStrategy()
                                 throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getZipEntries

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

getZipEntryAsByteArray

byte[] getZipEntryAsByteArray(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.Map<java.lang.String,java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>>> getZipFolderEntries()

getZipFolderEntries

java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> getZipFolderEntries(java.lang.String path)

getZipReader

com.liferay.portal.kernel.zip.ZipReader getZipReader()

getZipWriter

com.liferay.portal.kernel.zip.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 com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

importRatingsEntries

void importRatingsEntries(java.lang.Class<?> classObj,
                          long classPK,
                          long newClassPK)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.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)

setGroupId

void setGroupId(long groupId)

setOldPlid

void setOldPlid(long oldPlid)

setPlid

void setPlid(long plid)

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)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD