Interface PortletDataContext
- All Superinterfaces:
Serializable
Holds context information that is used during exporting and importing portlet data.
- Author:
- Brian Wing Shun Chan, Raymond Augé, Máté Thurzó
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
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
void
void
addPermissions
(Class<?> clazz, Serializable classPK) void
addPermissions
(String resourceName, long resourcePK) void
addPermissions
(String resourceName, long resourcePK, List<KeyValuePair> permissions) void
void
addPortletPermissions
(String resourceName) boolean
addPrimaryKey
(Class<?> clazz, String primaryKey) addReferenceElement
(ClassedModel referrerClassedModel, Element element, ClassedModel classedModel, String referenceType, boolean missing) addReferenceElement
(ClassedModel referrerClassedModel, Element element, ClassedModel classedModel, String binPath, String referenceType, boolean missing) addReferenceElement
(ClassedModel referrerClassedModel, Element element, ClassedModel classedModel, String className, String binPath, String referenceType, boolean missing) boolean
addScopedPrimaryKey
(Class<?> clazz, String primaryKey) void
addScopedPrimaryKeys
(Collection<String> scopedPrimaryKeys) 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
createServiceContext
(StagedModel stagedModel) createServiceContext
(StagedModel stagedModel, Class<?> clazz) createServiceContext
(Element element, ClassedModel classedModel) createServiceContext
(String path, ClassedModel classedModel) fromXML
(byte[] bytes) long[]
getAssetCategoryIds
(Class<?> clazz, Serializable classPK) String[]
getAssetTagNames
(Class<?> clazz, Serializable classPK) String[]
getAssetTagNames
(String className, Serializable classPK) boolean
getBooleanParameter
(String namespace, String name) boolean
getBooleanParameter
(String namespace, String name, boolean useDefaultValue) long
long
getDateRangeCriteria
(String propertyName) getExportDataElement
(ClassedModel classedModel) getExportDataElement
(ClassedModel classedModel, String modelClassSimpleName) getExportDataGroupElement
(Class<? extends StagedModel> clazz) long
getImportDataElement
(StagedModel stagedModel) getImportDataElement
(String name, String attribute, String value) getImportDataGroupElement
(Class<? extends StagedModel> clazz) getImportDataStagedModelElement
(StagedModel stagedModel) long[]
getLocks()
getMissingReferenceElement
(ClassedModel classedModel) getNewPrimaryKey
(String className, Object newPrimaryKey) Map<?,
?> getNewPrimaryKeysMap
(Class<?> clazz) Map<?,
?> getNewPrimaryKeysMap
(String className) long
getPlid()
getReferenceDataElement
(StagedModel parentStagedModel, Class<?> clazz, long classPK) getReferenceDataElement
(StagedModel parentStagedModel, Class<?> clazz, long groupId, String uuid) getReferenceDataElement
(Element parentElement, Class<?> clazz, long classPK) getReferenceDataElement
(Element parentElement, Class<?> clazz, long groupId, String uuid) getReferenceDataElements
(StagedModel parentStagedModel, Class<?> clazz) getReferenceDataElements
(StagedModel parentStagedModel, Class<?> clazz, String referenceType) getReferenceDataElements
(Element parentElement, Class<?> clazz, String referenceType) getReferenceElement
(StagedModel parentStagedModel, String className, Serializable classPK) getReferenceElement
(Element parentElement, Class<?> clazz, long groupId, String uuid, String referenceType) getReferenceElement
(String className, Serializable classPK) getReferenceElements
(StagedModel parentStagedModel, Class<?> clazz) long
long
long
long
long
getType()
long
long
byte[]
getZipEntryAsByteArray
(String path) getZipEntryAsObject
(Element element, String path) getZipEntryAsObject
(String path) getZipEntryAsString
(String path) getZipFolderEntries
(String path) boolean
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
void
importPortletPermissions
(String resourceName) boolean
boolean
boolean
boolean
isMissingReference
(Element referenceElement) boolean
isModelCounted
(String className, Serializable classPK) default boolean
boolean
isPathExportedInScope
(String path) boolean
isPathNotProcessed
(String path) boolean
isPathProcessed
(String path) boolean
boolean
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
setImportDataElementCacheEnabled
(boolean importDataElementCacheEnabled) 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
setOriginalPrivateLayout
(boolean originalPrivateLayout) 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
void
setUserIdStrategy
(UserIdStrategy userIdStrategy) void
setUserPersonalSiteGroupId
(long userPersonalSiteGroupId) void
setZipReader
(ZipReader zipReader) void
setZipWriter
(ZipWriter zipWriter)
-
Field Details
-
REFERENCE_TYPE_CHILD
- See Also:
-
REFERENCE_TYPE_DEPENDENCY
- See Also:
-
REFERENCE_TYPE_DEPENDENCY_DISPOSABLE
- See Also:
-
REFERENCE_TYPE_EMBEDDED
- See Also:
-
REFERENCE_TYPE_PARENT
- See Also:
-
REFERENCE_TYPE_STRONG
- See Also:
-
REFERENCE_TYPE_WEAK
- See Also:
-
-
Method Details
-
addAssetCategories
-
addAssetTags
-
addClassedModel
void addClassedModel(Element element, String path, ClassedModel classedModel) throws PortalException - Throws:
PortalException
-
addClassedModel
void addClassedModel(Element element, String path, ClassedModel classedModel, Class<?> clazz) throws PortalException - Throws:
PortalException
-
addDateRangeCriteria
-
addDeletionSystemEventStagedModelTypes
-
addLocks
- Throws:
PortalException
-
addLocks
-
addPermissions
- Throws:
PortalException
-
addPermissions
- Throws:
PortalException
-
addPermissions
-
addPortalPermissions
- Throws:
PortalException
-
addPortletPermissions
- Throws:
PortalException
-
addPrimaryKey
-
addReferenceElement
Element addReferenceElement(ClassedModel referrerClassedModel, Element element, ClassedModel classedModel, String referenceType, boolean missing) -
addReferenceElement
Element addReferenceElement(ClassedModel referrerClassedModel, Element element, ClassedModel classedModel, String binPath, String referenceType, boolean missing) -
addReferenceElement
Element addReferenceElement(ClassedModel referrerClassedModel, Element element, ClassedModel classedModel, String className, String binPath, String referenceType, boolean missing) -
addScopedPrimaryKey
-
addScopedPrimaryKeys
-
addZipEntry
-
addZipEntry
-
addZipEntry
-
addZipEntry
-
addZipEntry
-
cleanUpMissingReferences
-
clearScopedPrimaryKeys
void clearScopedPrimaryKeys() -
createServiceContext
-
createServiceContext
-
createServiceContext
-
createServiceContext
-
fromXML
-
fromXML
-
getAssetCategoryIds
-
getAssetLinkIds
-
getAssetTagNames
-
getAssetTagNames
-
getAssetTagNamesMap
-
getBooleanParameter
-
getBooleanParameter
-
getClassLoader
ClassLoader getClassLoader() -
getCompanyGroupId
long getCompanyGroupId() -
getCompanyId
long getCompanyId() -
getDataStrategy
String getDataStrategy() -
getDateRange
DateRange getDateRange() -
getDateRangeCriteria
-
getDeletionSystemEventStagedModelTypes
Set<StagedModelType> getDeletionSystemEventStagedModelTypes() -
getEndDate
Date getEndDate() -
getExportDataElement
-
getExportDataElement
-
getExportDataGroupElement
-
getExportDataRootElement
Element getExportDataRootElement() -
getExportImportProcessId
String getExportImportProcessId() -
getGroupId
long getGroupId() -
getImportDataElement
-
getImportDataElement
-
getImportDataGroupElement
-
getImportDataRootElement
Element getImportDataRootElement() -
getImportDataStagedModelElement
-
getLayoutIds
long[] getLayoutIds() -
getLayoutSetPrototypeUuid
String getLayoutSetPrototypeUuid() -
getLocks
-
getManifestSummary
ManifestSummary getManifestSummary() -
getMissingReferenceElement
-
getMissingReferencesElement
Element getMissingReferencesElement() -
getNewPrimaryKey
-
getNewPrimaryKeysMap
-
getNewPrimaryKeysMap
-
getNewPrimaryKeysMaps
-
getParameterMap
-
getPermissions
Map<String,List<KeyValuePair>> getPermissions() -
getPlid
long getPlid() -
getPortletId
String getPortletId() -
getPrimaryKeys
-
getReferenceDataElement
-
getReferenceDataElement
-
getReferenceDataElement
-
getReferenceDataElement
Element getReferenceDataElement(StagedModel parentStagedModel, Class<?> clazz, long groupId, String uuid) -
getReferenceDataElements
-
getReferenceDataElements
-
getReferenceDataElements
List<Element> getReferenceDataElements(StagedModel parentStagedModel, Class<?> clazz, String referenceType) -
getReferenceElement
-
getReferenceElement
-
getReferenceElement
-
getReferenceElements
-
getRootPortletId
String getRootPortletId() -
getScopedPrimaryKeys
-
getScopeGroupId
long getScopeGroupId() -
getScopeLayoutUuid
String getScopeLayoutUuid() -
getScopeType
String getScopeType() -
getSourceCompanyGroupId
long getSourceCompanyGroupId() -
getSourceCompanyId
long getSourceCompanyId() -
getSourceGroupId
long getSourceGroupId() -
getSourceUserPersonalSiteGroupId
long getSourceUserPersonalSiteGroupId() -
getStartDate
Date getStartDate() -
getType
String getType() -
getUserId
-
getUserIdStrategy
UserIdStrategy getUserIdStrategy() -
getUserPersonalSiteGroupId
long getUserPersonalSiteGroupId() -
getZipEntryAsByteArray
-
getZipEntryAsInputStream
-
getZipEntryAsObject
-
getZipEntryAsObject
-
getZipEntryAsString
-
getZipFolderEntries
-
getZipReader
ZipReader getZipReader() -
getZipWriter
ZipWriter getZipWriter() -
hasDateRange
boolean hasDateRange() -
hasNotUniquePerLayout
-
hasPrimaryKey
-
hasScopedPrimaryKey
-
importClassedModel
void importClassedModel(ClassedModel classedModel, ClassedModel newClassedModel) throws PortalException - Throws:
PortalException
-
importClassedModel
void importClassedModel(ClassedModel classedModel, ClassedModel newClassedModel, Class<?> clazz) throws PortalException - Throws:
PortalException
-
importLocks
- Throws:
PortalException
-
importPermissions
void importPermissions(Class<?> clazz, Serializable classPK, Serializable newClassPK) throws PortalException - Throws:
PortalException
-
importPermissions
void importPermissions(String resourceName, long resourcePK, long newResourcePK) throws PortalException - Throws:
PortalException
-
importPortalPermissions
- Throws:
PortalException
-
importPortletPermissions
- Throws:
PortalException
-
isDataStrategyMirror
boolean isDataStrategyMirror() -
isDataStrategyMirrorWithOverwriting
boolean isDataStrategyMirrorWithOverwriting() -
isInitialPublication
boolean isInitialPublication() -
isMissingReference
-
isModelCounted
-
isOriginalPrivateLayout
default boolean isOriginalPrivateLayout() -
isPathExportedInScope
-
isPathNotProcessed
-
isPathProcessed
-
isPerformDirectBinaryImport
boolean isPerformDirectBinaryImport() -
isPrivateLayout
boolean isPrivateLayout() -
isStagedModelCounted
-
isWithinDateRange
-
putNotUniquePerLayout
-
removePrimaryKey
-
setClassLoader
-
setCompanyGroupId
void setCompanyGroupId(long companyGroupId) -
setCompanyId
void setCompanyId(long companyId) -
setDataStrategy
-
setEndDate
-
setExportDataRootElement
-
setExportImportProcessId
-
setGroupId
void setGroupId(long groupId) -
setImportDataElementCacheEnabled
void setImportDataElementCacheEnabled(boolean importDataElementCacheEnabled) -
setImportDataRootElement
-
setLayoutIds
void setLayoutIds(long[] layoutIds) -
setLayoutSetPrototypeUuid
-
setManifestSummary
-
setMissingReferencesElement
-
setNewLayouts
-
setOriginalPrivateLayout
void setOriginalPrivateLayout(boolean originalPrivateLayout) -
setParameterMap
-
setPlid
void setPlid(long plid) -
setPortletId
-
setPrivateLayout
void setPrivateLayout(boolean privateLayout) -
setScopeGroupId
void setScopeGroupId(long scopeGroupId) -
setScopeLayoutUuid
-
setScopeType
-
setSourceCompanyGroupId
void setSourceCompanyGroupId(long sourceCompanyGroupId) -
setSourceCompanyId
void setSourceCompanyId(long sourceCompanyId) -
setSourceGroupId
void setSourceGroupId(long sourceGroupId) -
setSourceUserPersonalSiteGroupId
void setSourceUserPersonalSiteGroupId(long sourceUserPersonalSiteGroupId) -
setStartDate
-
setType
-
setUserIdStrategy
-
setUserPersonalSiteGroupId
void setUserPersonalSiteGroupId(long userPersonalSiteGroupId) -
setZipReader
-
setZipWriter
-
toXML
-