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.kernel.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, java.lang.Object primaryKey)
           
 void addComments(java.lang.String className, java.lang.Object primaryKey, java.util.List messages)
           
 boolean addPrimaryKey(java.lang.Class<?> classObj, java.lang.Object primaryKey)
           
 void addRatingsEntries(java.lang.Class<?> classObj, java.lang.Object primaryKey)
           
 void addRatingsEntries(java.lang.String className, java.lang.Object primaryKey, java.util.List entries)
           
 void addTagsEntries(java.lang.Class<?> classObj, java.lang.Object classPK)
           
 void addTagsEntries(java.lang.String className, java.lang.Object classPK, java.lang.String[] values)
           
 void addZipEntry(java.lang.String path, byte[] bytes)
           
 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> getComments()
           
 long getCompanyId()
           
 java.lang.String getDataStrategy()
           
 java.util.Date getEndDate()
           
 long getGroupId()
           
 long getImportGroupId()
           
 java.lang.String getImportLayoutPath(long layoutId)
           
 java.lang.String getImportPortletPath(java.lang.String portletId)
           
 java.lang.String getImportRootPath()
           
 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 getPrimaryKeys()
           
 java.util.Map<java.lang.String,java.util.List> getRatingsEntries()
           
 java.lang.String getRootPath()
           
 java.util.Date getStartDate()
           
 java.util.Map<java.lang.String,java.lang.String[]> getTagsEntries()
           
 java.lang.String[] getTagsEntries(java.lang.Class<?> classObj, java.lang.Object primaryKey)
           
 java.lang.String[] getTagsEntries(java.lang.String className, java.lang.Object primaryKey)
           
 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<ObjectValuePair<java.lang.String,byte[]>>> getZipFolderEntries()
           
 java.util.List<ObjectValuePair<java.lang.String,byte[]>> getZipFolderEntries(java.lang.String path)
           
 ZipReader getZipReader()
           
 ZipWriter getZipWriter()
           
 boolean hasDateRange()
           
 boolean hasPrimaryKey(java.lang.Class<?> classObj, java.lang.Object primaryKey)
           
 void importComments(java.lang.Class<?> classObj, java.lang.Object primaryKey, java.lang.Object newPrimaryKey, long groupId)
           
 void importRatingsEntries(java.lang.Class<?> classObj, java.lang.Object primaryKey, java.lang.Object newPrimaryKey)
           
 boolean isPathNotProcessed(java.lang.String path)
           
 boolean isWithinDateRange(java.util.Date modifiedDate)
           
 void setImportGroupId(long importGroupId)
           
 void setOldPlid(long oldPlid)
           
 void setPlid(long plid)
           
 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,
                 java.lang.Object primaryKey)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

addComments

void addComments(java.lang.String className,
                 java.lang.Object primaryKey,
                 java.util.List messages)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

addPrimaryKey

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

addRatingsEntries

void addRatingsEntries(java.lang.Class<?> classObj,
                       java.lang.Object primaryKey)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

addRatingsEntries

void addRatingsEntries(java.lang.String className,
                       java.lang.Object primaryKey,
                       java.util.List entries)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

addTagsEntries

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

addTagsEntries

void addTagsEntries(java.lang.String className,
                    java.lang.Object classPK,
                    java.lang.String[] values)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

addZipEntry

void addZipEntry(java.lang.String path,
                 byte[] bytes)
                 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)

getBooleanParameter

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

getComments

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

getCompanyId

long getCompanyId()

getDataStrategy

java.lang.String getDataStrategy()

getEndDate

java.util.Date getEndDate()

getGroupId

long getGroupId()

getImportGroupId

long getImportGroupId()

getImportLayoutPath

java.lang.String getImportLayoutPath(long layoutId)

getImportPortletPath

java.lang.String getImportPortletPath(java.lang.String portletId)

getImportRootPath

java.lang.String getImportRootPath()

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

getRatingsEntries

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

getRootPath

java.lang.String getRootPath()

getStartDate

java.util.Date getStartDate()

getTagsEntries

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

getTagsEntries

java.lang.String[] getTagsEntries(java.lang.Class<?> classObj,
                                  java.lang.Object primaryKey)

getTagsEntries

java.lang.String[] getTagsEntries(java.lang.String className,
                                  java.lang.Object primaryKey)

getUserId

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

getUserIdStrategy

UserIdStrategy getUserIdStrategy()
                                 throws SystemException
Throws:
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<ObjectValuePair<java.lang.String,byte[]>>> getZipFolderEntries()

getZipFolderEntries

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

getZipReader

ZipReader getZipReader()

getZipWriter

ZipWriter getZipWriter()

hasDateRange

boolean hasDateRange()

hasPrimaryKey

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

importComments

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

importRatingsEntries

void importRatingsEntries(java.lang.Class<?> classObj,
                          java.lang.Object primaryKey,
                          java.lang.Object newPrimaryKey)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

isPathNotProcessed

boolean isPathNotProcessed(java.lang.String path)

isWithinDateRange

boolean isWithinDateRange(java.util.Date modifiedDate)

setImportGroupId

void setImportGroupId(long importGroupId)

setOldPlid

void setOldPlid(long oldPlid)

setPlid

void setPlid(long plid)

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