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 TypeMethodDescriptionvoidaddAssetCategories(String className, long classPK, long[] assetCategoryIds) voidaddAssetTags(String className, long classPK, String[] assetTagNames) voidaddClassedModel(Element element, String path, ClassedModel classedModel) voidaddClassedModel(Element element, String path, ClassedModel classedModel, Class<?> clazz) voidaddDateRangeCriteria(DynamicQuery dynamicQuery, String propertyName) voidaddDeletionSystemEventStagedModelTypes(StagedModelType... stagedModelTypes) voidvoidvoidaddPermissions(Class<?> clazz, Serializable classPK) voidaddPermissions(String resourceName, long resourcePK) voidaddPermissions(String resourceName, long resourcePK, List<KeyValuePair> permissions) voidvoidaddPortletPermissions(String resourceName) booleanaddPrimaryKey(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) booleanaddScopedPrimaryKey(Class<?> clazz, String primaryKey) voidaddScopedPrimaryKeys(Collection<String> scopedPrimaryKeys) voidaddZipEntry(String path, byte[] bytes) voidaddZipEntry(String path, InputStream inputStream) voidaddZipEntry(String path, Object object) voidaddZipEntry(String path, String s) voidaddZipEntry(String name, StringBuilder sb) voidcleanUpMissingReferences(ClassedModel classedModel) voidcreateServiceContext(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) booleangetBooleanParameter(String namespace, String name) booleangetBooleanParameter(String namespace, String name, boolean useDefaultValue) longlonggetDateRangeCriteria(String propertyName) getExportDataElement(ClassedModel classedModel) getExportDataElement(ClassedModel classedModel, String modelClassSimpleName) getExportDataGroupElement(Class<? extends StagedModel> clazz) longgetImportDataElement(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) longgetPlid()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) longlonglonglonglonggetType()longlongbyte[]getZipEntryAsByteArray(String path) getZipEntryAsObject(Element element, String path) getZipEntryAsObject(String path) getZipEntryAsString(String path) getZipFolderEntries(String path) booleanbooleanhasNotUniquePerLayout(String dataKey) booleanhasPrimaryKey(Class<?> clazz, String primaryKey) booleanhasScopedPrimaryKey(Class<?> clazz, String primaryKey) voidimportClassedModel(ClassedModel classedModel, ClassedModel newClassedModel) voidimportClassedModel(ClassedModel classedModel, ClassedModel newClassedModel, Class<?> clazz) voidimportLocks(Class<?> clazz, String key, String newKey) voidimportPermissions(Class<?> clazz, Serializable classPK, Serializable newClassPK) voidimportPermissions(String resourceName, long resourcePK, long newResourcePK) voidvoidimportPortletPermissions(String resourceName) booleanbooleanbooleanbooleanisMissingReference(Element referenceElement) booleanisModelCounted(String className, Serializable classPK) default booleanbooleanisPathExportedInScope(String path) booleanisPathNotProcessed(String path) booleanisPathProcessed(String path) booleanbooleanbooleanisStagedModelCounted(StagedModel stagedModel) booleanisWithinDateRange(Date modifiedDate) voidputNotUniquePerLayout(String dataKey) voidremovePrimaryKey(String path) voidsetClassLoader(ClassLoader classLoader) voidsetCompanyGroupId(long companyGroupId) voidsetCompanyId(long companyId) voidsetDataStrategy(String dataStrategy) voidsetEndDate(Date endDate) voidsetExportDataRootElement(Element exportDataRootElement) voidsetExportImportProcessId(String exportImportProcessId) voidsetGroupId(long groupId) voidsetImportDataElementCacheEnabled(boolean importDataElementCacheEnabled) voidsetImportDataRootElement(Element importDataRootElement) voidsetLayoutIds(long[] layoutIds) voidsetLayoutSetPrototypeUuid(String layoutSetPrototypeUuid) voidsetManifestSummary(ManifestSummary manifestSummary) voidsetMissingReferencesElement(Element missingReferencesElement) voidsetNewLayouts(List<Layout> newLayouts) voidsetOriginalPrivateLayout(boolean originalPrivateLayout) voidsetParameterMap(Map<String, String[]> parameterMap) voidsetPlid(long plid) voidsetPortletId(String portletId) voidsetPrivateLayout(boolean privateLayout) voidsetScopeGroupId(long scopeGroupId) voidsetScopeLayoutUuid(String scopeLayoutUuid) voidsetScopeType(String scopeType) voidsetSourceCompanyGroupId(long sourceCompanyGroupId) voidsetSourceCompanyId(long sourceCompanyId) voidsetSourceGroupId(long sourceGroupId) voidsetSourceUserPersonalSiteGroupId(long sourceUserPersonalSiteGroupId) voidsetStartDate(Date startDate) voidvoidsetUserIdStrategy(UserIdStrategy userIdStrategy) voidsetUserPersonalSiteGroupId(long userPersonalSiteGroupId) voidsetZipReader(ZipReader zipReader) voidsetZipWriter(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
-