@ProviderType
public interface PortletDataContext
extends Serializable
Holds context information that is used during exporting and importing portlet data.
Modifier and Type | Field and Description |
---|---|
static String |
REFERENCE_TYPE_CHILD |
static String |
REFERENCE_TYPE_DEPENDENCY |
static String |
REFERENCE_TYPE_DEPENDENCY_DISPOSABLE |
static String |
REFERENCE_TYPE_EMBEDDED |
static String |
REFERENCE_TYPE_PARENT |
static String |
REFERENCE_TYPE_STRONG |
static String |
REFERENCE_TYPE_WEAK |
Modifier and Type | Method and Description |
---|---|
void |
addAssetCategories(String className,
long classPK,
long[] assetCategoryIds) |
void |
addAssetTags(String className,
long classPK,
String[] assetTagNames) |
void |
addClassedModel(Element element,
String path,
ClassedModel classedModel) |
void |
addClassedModel(Element element,
String path,
ClassedModel classedModel,
Class<?> clazz) |
void |
addDateRangeCriteria(DynamicQuery dynamicQuery,
String propertyName) |
void |
addDeletionSystemEventStagedModelTypes(StagedModelType... stagedModelTypes) |
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,
Serializable classPK) |
void |
addPermissions(String resourceName,
long resourcePK) |
void |
addPermissions(String resourceName,
long resourcePK,
List<KeyValuePair> permissions) |
void |
addPortalPermissions() |
void |
addPortletPermissions(String resourceName) |
boolean |
addPrimaryKey(Class<?> clazz,
String primaryKey) |
Element |
addReferenceElement(ClassedModel referrerClassedModel,
Element element,
ClassedModel classedModel,
String referenceType,
boolean missing) |
Element |
addReferenceElement(ClassedModel referrerClassedModel,
Element element,
ClassedModel classedModel,
String binPath,
String referenceType,
boolean missing) |
Element |
addReferenceElement(ClassedModel referrerClassedModel,
Element element,
ClassedModel classedModel,
String className,
String binPath,
String referenceType,
boolean missing) |
boolean |
addScopedPrimaryKey(Class<?> clazz,
String primaryKey) |
void |
addZipEntry(String path,
byte[] bytes) |
void |
addZipEntry(String path,
InputStream inputStream) |
void |
addZipEntry(String path,
Object object) |
void |
addZipEntry(String path,
String s) |
void |
addZipEntry(String name,
StringBuilder sb) |
void |
cleanUpMissingReferences(ClassedModel classedModel) |
void |
clearScopedPrimaryKeys() |
ServiceContext |
createServiceContext(Element element,
ClassedModel classedModel) |
ServiceContext |
createServiceContext(StagedModel stagedModel) |
ServiceContext |
createServiceContext(StagedModel stagedModel,
Class<?> clazz) |
ServiceContext |
createServiceContext(String path,
ClassedModel classedModel) |
Object |
fromXML(byte[] bytes) |
Object |
fromXML(String xml) |
long[] |
getAssetCategoryIds(Class<?> clazz,
Serializable classPK) |
Set<Long> |
getAssetLinkIds() |
String[] |
getAssetTagNames(Class<?> clazz,
Serializable classPK) |
String[] |
getAssetTagNames(String className,
Serializable classPK) |
Map<String,String[]> |
getAssetTagNamesMap() |
boolean |
getBooleanParameter(String namespace,
String name) |
boolean |
getBooleanParameter(String namespace,
String name,
boolean useDefaultValue) |
ClassLoader |
getClassLoader() |
long |
getCompanyGroupId() |
long |
getCompanyId() |
String |
getDataStrategy() |
DateRange |
getDateRange() |
Criterion |
getDateRangeCriteria(String propertyName) |
Set<StagedModelType> |
getDeletionSystemEventStagedModelTypes() |
Date |
getEndDate() |
Map<String,List<ExpandoColumn>> |
getExpandoColumns() |
Element |
getExportDataElement(ClassedModel classedModel) |
Element |
getExportDataElement(ClassedModel classedModel,
String modelClassSimpleName) |
Element |
getExportDataGroupElement(Class<? extends StagedModel> clazz) |
Element |
getExportDataRootElement() |
String |
getExportImportProcessId() |
long |
getGroupId() |
Element |
getImportDataElement(StagedModel stagedModel) |
Element |
getImportDataElement(String name,
String attribute,
String value) |
Element |
getImportDataGroupElement(Class<? extends StagedModel> clazz) |
Element |
getImportDataRootElement() |
Element |
getImportDataStagedModelElement(StagedModel stagedModel) |
long[] |
getLayoutIds() |
String |
getLayoutSetPrototypeUuid() |
Map<String,Lock> |
getLocks() |
ManifestSummary |
getManifestSummary() |
Element |
getMissingReferenceElement(ClassedModel classedModel) |
Element |
getMissingReferencesElement() |
Object |
getNewPrimaryKey(Class<?> clazz,
Object newPrimaryKey) |
Object |
getNewPrimaryKey(String className,
Object newPrimaryKey) |
Map<?,?> |
getNewPrimaryKeysMap(Class<?> clazz) |
Map<?,?> |
getNewPrimaryKeysMap(String className) |
Map<String,Map<?,?>> |
getNewPrimaryKeysMaps() |
Map<String,String[]> |
getParameterMap() |
Map<String,List<KeyValuePair>> |
getPermissions() |
long |
getPlid() |
String |
getPortletId() |
Set<String> |
getPrimaryKeys() |
Element |
getReferenceDataElement(Element parentElement,
Class<?> clazz,
long classPK) |
Element |
getReferenceDataElement(Element parentElement,
Class<?> clazz,
long groupId,
String uuid) |
Element |
getReferenceDataElement(StagedModel parentStagedModel,
Class<?> clazz,
long classPK) |
Element |
getReferenceDataElement(StagedModel parentStagedModel,
Class<?> clazz,
long groupId,
String uuid) |
List<Element> |
getReferenceDataElements(Element parentElement,
Class<?> clazz,
String referenceType) |
List<Element> |
getReferenceDataElements(StagedModel parentStagedModel,
Class<?> clazz) |
List<Element> |
getReferenceDataElements(StagedModel parentStagedModel,
Class<?> clazz,
String referenceType) |
Element |
getReferenceElement(Class<?> clazz,
Serializable classPK) |
Element |
getReferenceElement(Element parentElement,
Class<?> clazz,
long groupId,
String uuid,
String referenceType) |
Element |
getReferenceElement(StagedModel parentStagedModel,
Class<?> clazz,
Serializable classPK) |
Element |
getReferenceElement(StagedModel parentStagedModel,
String className,
Serializable classPK) |
Element |
getReferenceElement(String className,
Serializable classPK) |
List<Element> |
getReferenceElements(StagedModel parentStagedModel,
Class<?> clazz) |
String |
getRootPortletId() |
long |
getScopeGroupId() |
String |
getScopeLayoutUuid() |
String |
getScopeType() |
long |
getSourceCompanyGroupId() |
long |
getSourceCompanyId() |
long |
getSourceGroupId() |
long |
getSourceUserPersonalSiteGroupId() |
Date |
getStartDate() |
String |
getType() |
long |
getUserId(String userUuid) |
UserIdStrategy |
getUserIdStrategy() |
long |
getUserPersonalSiteGroupId() |
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(String path) |
ZipReader |
getZipReader() |
ZipWriter |
getZipWriter() |
boolean |
hasDateRange() |
boolean |
hasNotUniquePerLayout(String dataKey) |
boolean |
hasPrimaryKey(Class<?> clazz,
String primaryKey) |
boolean |
hasScopedPrimaryKey(Class<?> clazz,
String primaryKey) |
void |
importClassedModel(ClassedModel classedModel,
ClassedModel newClassedModel) |
void |
importClassedModel(ClassedModel classedModel,
ClassedModel newClassedModel,
Class<?> clazz) |
void |
importLocks(Class<?> clazz,
String key,
String newKey) |
void |
importPermissions(Class<?> clazz,
Serializable classPK,
Serializable newClassPK) |
void |
importPermissions(String resourceName,
long resourcePK,
long newResourcePK) |
void |
importPortalPermissions() |
void |
importPortletPermissions(String resourceName) |
boolean |
isCompanyStagedGroupedModel(StagedGroupedModel stagedGroupedModel) |
boolean |
isDataStrategyMirror() |
boolean |
isDataStrategyMirrorWithOverwriting() |
boolean |
isInitialPublication() |
boolean |
isMissingReference(Element referenceElement) |
boolean |
isModelCounted(String className,
Serializable classPK) |
boolean |
isPathExportedInScope(String path) |
boolean |
isPathNotProcessed(String path) |
boolean |
isPathProcessed(String path) |
boolean |
isPerformDirectBinaryImport() |
boolean |
isPrivateLayout() |
boolean |
isStagedModelCounted(StagedModel stagedModel) |
boolean |
isWithinDateRange(Date modifiedDate) |
void |
putNotUniquePerLayout(String dataKey) |
void |
removePrimaryKey(String path) |
void |
setClassLoader(ClassLoader classLoader) |
void |
setCompanyGroupId(long companyGroupId) |
void |
setCompanyId(long companyId) |
void |
setDataStrategy(String dataStrategy) |
void |
setEndDate(Date endDate) |
void |
setExportDataRootElement(Element exportDataRootElement) |
void |
setExportImportProcessId(String exportImportProcessId) |
void |
setGroupId(long groupId) |
void |
setImportDataRootElement(Element importDataRootElement) |
void |
setLayoutIds(long[] layoutIds) |
void |
setLayoutSetPrototypeUuid(String layoutSetPrototypeUuid) |
void |
setManifestSummary(ManifestSummary manifestSummary) |
void |
setMissingReferencesElement(Element missingReferencesElement) |
void |
setNewLayouts(List<Layout> newLayouts) |
void |
setParameterMap(Map<String,String[]> parameterMap) |
void |
setPlid(long plid) |
void |
setPortletId(String portletId) |
void |
setPrivateLayout(boolean privateLayout) |
void |
setScopeGroupId(long scopeGroupId) |
void |
setScopeLayoutUuid(String scopeLayoutUuid) |
void |
setScopeType(String scopeType) |
void |
setSourceCompanyGroupId(long sourceCompanyGroupId) |
void |
setSourceCompanyId(long sourceCompanyId) |
void |
setSourceGroupId(long sourceGroupId) |
void |
setSourceUserPersonalSiteGroupId(long sourceUserPersonalSiteGroupId) |
void |
setStartDate(Date startDate) |
void |
setType(String type) |
void |
setUserIdStrategy(UserIdStrategy userIdStrategy) |
void |
setUserPersonalSiteGroupId(long userPersonalSiteGroupId) |
void |
setZipReader(ZipReader zipReader) |
void |
setZipWriter(ZipWriter zipWriter) |
String |
toXML(Object object) |
static final String REFERENCE_TYPE_CHILD
static final String REFERENCE_TYPE_DEPENDENCY
static final String REFERENCE_TYPE_DEPENDENCY_DISPOSABLE
static final String REFERENCE_TYPE_EMBEDDED
static final String REFERENCE_TYPE_PARENT
static final String REFERENCE_TYPE_STRONG
static final String REFERENCE_TYPE_WEAK
void addAssetCategories(String className, long classPK, long[] assetCategoryIds)
void addAssetTags(String className, long classPK, String[] assetTagNames)
void addClassedModel(Element element, String path, ClassedModel classedModel) throws PortalException
PortalException
void addClassedModel(Element element, String path, ClassedModel classedModel, Class<?> clazz) throws PortalException
PortalException
void addDateRangeCriteria(DynamicQuery dynamicQuery, String propertyName)
void addDeletionSystemEventStagedModelTypes(StagedModelType... stagedModelTypes)
void addExpando(Element element, String path, ClassedModel classedModel) throws PortalException
PortalException
void addLocks(Class<?> clazz, String key) throws PortalException
PortalException
void addLocks(String className, String key, Lock lock)
void addPermissions(Class<?> clazz, Serializable classPK) throws PortalException
PortalException
void addPermissions(String resourceName, long resourcePK) throws PortalException
PortalException
void addPermissions(String resourceName, long resourcePK, List<KeyValuePair> permissions)
void addPortalPermissions() throws PortalException
PortalException
void addPortletPermissions(String resourceName) throws PortalException
PortalException
boolean addPrimaryKey(Class<?> clazz, String primaryKey)
Element addReferenceElement(ClassedModel referrerClassedModel, Element element, ClassedModel classedModel, String referenceType, boolean missing)
Element addReferenceElement(ClassedModel referrerClassedModel, Element element, ClassedModel classedModel, String binPath, String referenceType, boolean missing)
Element addReferenceElement(ClassedModel referrerClassedModel, Element element, ClassedModel classedModel, String className, String binPath, String referenceType, boolean missing)
boolean addScopedPrimaryKey(Class<?> clazz, String primaryKey)
void addZipEntry(String path, byte[] bytes)
void addZipEntry(String path, InputStream inputStream)
void addZipEntry(String path, Object object)
void addZipEntry(String path, String s)
void addZipEntry(String name, StringBuilder sb)
void cleanUpMissingReferences(ClassedModel classedModel)
void clearScopedPrimaryKeys()
ServiceContext createServiceContext(Element element, ClassedModel classedModel)
ServiceContext createServiceContext(StagedModel stagedModel)
ServiceContext createServiceContext(StagedModel stagedModel, Class<?> clazz)
ServiceContext createServiceContext(String path, ClassedModel classedModel)
Object fromXML(byte[] bytes)
Object fromXML(String xml)
long[] getAssetCategoryIds(Class<?> clazz, Serializable classPK)
Set<Long> getAssetLinkIds()
String[] getAssetTagNames(Class<?> clazz, Serializable classPK)
String[] getAssetTagNames(String className, Serializable classPK)
Map<String,String[]> getAssetTagNamesMap()
boolean getBooleanParameter(String namespace, String name)
boolean getBooleanParameter(String namespace, String name, boolean useDefaultValue)
ClassLoader getClassLoader()
long getCompanyGroupId()
long getCompanyId()
String getDataStrategy()
DateRange getDateRange()
Criterion getDateRangeCriteria(String propertyName)
Set<StagedModelType> getDeletionSystemEventStagedModelTypes()
Date getEndDate()
Map<String,List<ExpandoColumn>> getExpandoColumns()
Element getExportDataElement(ClassedModel classedModel)
Element getExportDataElement(ClassedModel classedModel, String modelClassSimpleName)
Element getExportDataGroupElement(Class<? extends StagedModel> clazz)
Element getExportDataRootElement()
String getExportImportProcessId()
long getGroupId()
Element getImportDataElement(StagedModel stagedModel)
Element getImportDataElement(String name, String attribute, String value)
Element getImportDataGroupElement(Class<? extends StagedModel> clazz)
Element getImportDataRootElement()
Element getImportDataStagedModelElement(StagedModel stagedModel)
long[] getLayoutIds()
String getLayoutSetPrototypeUuid()
Map<String,Lock> getLocks()
ManifestSummary getManifestSummary()
Element getMissingReferenceElement(ClassedModel classedModel)
Element getMissingReferencesElement()
Object getNewPrimaryKey(Class<?> clazz, Object newPrimaryKey)
Object getNewPrimaryKey(String className, Object newPrimaryKey)
Map<?,?> getNewPrimaryKeysMap(Class<?> clazz)
Map<?,?> getNewPrimaryKeysMap(String className)
Map<String,Map<?,?>> getNewPrimaryKeysMaps()
Map<String,String[]> getParameterMap()
Map<String,List<KeyValuePair>> getPermissions()
long getPlid()
String getPortletId()
Set<String> getPrimaryKeys()
Element getReferenceDataElement(Element parentElement, Class<?> clazz, long classPK)
Element getReferenceDataElement(Element parentElement, Class<?> clazz, long groupId, String uuid)
Element getReferenceDataElement(StagedModel parentStagedModel, Class<?> clazz, long classPK)
Element getReferenceDataElement(StagedModel parentStagedModel, Class<?> clazz, long groupId, String uuid)
List<Element> getReferenceDataElements(Element parentElement, Class<?> clazz, String referenceType)
List<Element> getReferenceDataElements(StagedModel parentStagedModel, Class<?> clazz)
List<Element> getReferenceDataElements(StagedModel parentStagedModel, Class<?> clazz, String referenceType)
Element getReferenceElement(Class<?> clazz, Serializable classPK)
Element getReferenceElement(Element parentElement, Class<?> clazz, long groupId, String uuid, String referenceType)
Element getReferenceElement(StagedModel parentStagedModel, Class<?> clazz, Serializable classPK)
Element getReferenceElement(StagedModel parentStagedModel, String className, Serializable classPK)
Element getReferenceElement(String className, Serializable classPK)
List<Element> getReferenceElements(StagedModel parentStagedModel, Class<?> clazz)
String getRootPortletId()
long getScopeGroupId()
String getScopeLayoutUuid()
String getScopeType()
long getSourceCompanyGroupId()
long getSourceCompanyId()
long getSourceGroupId()
long getSourceUserPersonalSiteGroupId()
Date getStartDate()
String getType()
long getUserId(String userUuid)
UserIdStrategy getUserIdStrategy()
long getUserPersonalSiteGroupId()
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(String path)
ZipReader getZipReader()
ZipWriter getZipWriter()
boolean hasDateRange()
boolean hasNotUniquePerLayout(String dataKey)
boolean hasPrimaryKey(Class<?> clazz, String primaryKey)
boolean hasScopedPrimaryKey(Class<?> clazz, String primaryKey)
void importClassedModel(ClassedModel classedModel, ClassedModel newClassedModel) throws PortalException
PortalException
void importClassedModel(ClassedModel classedModel, ClassedModel newClassedModel, Class<?> clazz) throws PortalException
PortalException
void importLocks(Class<?> clazz, String key, String newKey) throws PortalException
PortalException
void importPermissions(Class<?> clazz, Serializable classPK, Serializable newClassPK) throws PortalException
PortalException
void importPermissions(String resourceName, long resourcePK, long newResourcePK) throws PortalException
PortalException
void importPortalPermissions() throws PortalException
PortalException
void importPortletPermissions(String resourceName) throws PortalException
PortalException
boolean isCompanyStagedGroupedModel(StagedGroupedModel stagedGroupedModel)
boolean isDataStrategyMirror()
boolean isDataStrategyMirrorWithOverwriting()
boolean isInitialPublication()
boolean isMissingReference(Element referenceElement)
boolean isModelCounted(String className, Serializable classPK)
boolean isPathExportedInScope(String path)
boolean isPathNotProcessed(String path)
boolean isPathProcessed(String path)
boolean isPerformDirectBinaryImport()
boolean isPrivateLayout()
boolean isStagedModelCounted(StagedModel stagedModel)
boolean isWithinDateRange(Date modifiedDate)
void putNotUniquePerLayout(String dataKey)
void removePrimaryKey(String path)
void setClassLoader(ClassLoader classLoader)
void setCompanyGroupId(long companyGroupId)
void setCompanyId(long companyId)
void setDataStrategy(String dataStrategy)
void setEndDate(Date endDate)
void setExportDataRootElement(Element exportDataRootElement)
void setExportImportProcessId(String exportImportProcessId)
void setGroupId(long groupId)
void setImportDataRootElement(Element importDataRootElement)
void setLayoutIds(long[] layoutIds)
void setLayoutSetPrototypeUuid(String layoutSetPrototypeUuid)
void setManifestSummary(ManifestSummary manifestSummary)
void setMissingReferencesElement(Element missingReferencesElement)
void setNewLayouts(List<Layout> newLayouts)
void setParameterMap(Map<String,String[]> parameterMap)
void setPlid(long plid)
void setPortletId(String portletId)
void setPrivateLayout(boolean privateLayout)
void setScopeGroupId(long scopeGroupId)
void setScopeLayoutUuid(String scopeLayoutUuid)
void setScopeType(String scopeType)
void setSourceCompanyGroupId(long sourceCompanyGroupId)
void setSourceCompanyId(long sourceCompanyId)
void setSourceGroupId(long sourceGroupId)
void setSourceUserPersonalSiteGroupId(long sourceUserPersonalSiteGroupId)
void setStartDate(Date startDate)
void setType(String type)
void setUserIdStrategy(UserIdStrategy userIdStrategy)
void setUserPersonalSiteGroupId(long userPersonalSiteGroupId)
void setZipReader(ZipReader zipReader)
void setZipWriter(ZipWriter zipWriter)
String toXML(Object object)