Interface PortletDataContext

All Superinterfaces:
Serializable

@ProviderType public interface PortletDataContext extends Serializable

Holds context information that is used during exporting and importing portlet data.

Author:
Brian Wing Shun Chan, Raymond Augé, Máté Thurzó
  • Field Details

  • Method Details

    • addAssetCategories

      void addAssetCategories(String className, long classPK, long[] assetCategoryIds)
    • addAssetTags

      void addAssetTags(String className, long classPK, String[] assetTagNames)
    • 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

      void addDateRangeCriteria(DynamicQuery dynamicQuery, String propertyName)
    • addDeletionSystemEventStagedModelTypes

      void addDeletionSystemEventStagedModelTypes(StagedModelType... stagedModelTypes)
    • addLocks

      void addLocks(Class<?> clazz, String key) throws PortalException
      Throws:
      PortalException
    • addLocks

      void addLocks(String className, String key, Lock lock)
    • addPermissions

      void addPermissions(Class<?> clazz, Serializable classPK) throws PortalException
      Throws:
      PortalException
    • addPermissions

      void addPermissions(String resourceName, long resourcePK) throws PortalException
      Throws:
      PortalException
    • addPermissions

      void addPermissions(String resourceName, long resourcePK, List<KeyValuePair> permissions)
    • addPortalPermissions

      void addPortalPermissions() throws PortalException
      Throws:
      PortalException
    • addPortletPermissions

      void addPortletPermissions(String resourceName) throws PortalException
      Throws:
      PortalException
    • addPrimaryKey

      boolean addPrimaryKey(Class<?> clazz, String primaryKey)
    • 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

      boolean addScopedPrimaryKey(Class<?> clazz, String primaryKey)
    • addScopedPrimaryKeys

      void addScopedPrimaryKeys(Collection<String> scopedPrimaryKeys)
    • addZipEntry

      void addZipEntry(String path, byte[] bytes)
    • addZipEntry

      void addZipEntry(String path, InputStream inputStream)
    • addZipEntry

      void addZipEntry(String path, Object object)
    • addZipEntry

      void addZipEntry(String path, String s)
    • addZipEntry

      void addZipEntry(String name, StringBuilder sb)
    • cleanUpMissingReferences

      void cleanUpMissingReferences(ClassedModel classedModel)
    • clearScopedPrimaryKeys

      void clearScopedPrimaryKeys()
    • createServiceContext

      ServiceContext createServiceContext(Element element, ClassedModel classedModel)
    • createServiceContext

      ServiceContext createServiceContext(StagedModel stagedModel)
    • createServiceContext

      ServiceContext createServiceContext(StagedModel stagedModel, Class<?> clazz)
    • createServiceContext

      ServiceContext createServiceContext(String path, ClassedModel classedModel)
    • fromXML

      Object fromXML(byte[] bytes)
    • fromXML

      Object fromXML(String xml)
    • getAssetCategoryIds

      long[] getAssetCategoryIds(Class<?> clazz, Serializable classPK)
    • getAssetLinkIds

      Set<Long> getAssetLinkIds()
    • getAssetTagNames

      String[] getAssetTagNames(Class<?> clazz, Serializable classPK)
    • getAssetTagNames

      String[] getAssetTagNames(String className, Serializable classPK)
    • getAssetTagNamesMap

      Map<String,String[]> getAssetTagNamesMap()
    • getBooleanParameter

      boolean getBooleanParameter(String namespace, String name)
    • getBooleanParameter

      boolean getBooleanParameter(String namespace, String name, boolean useDefaultValue)
    • getClassLoader

      ClassLoader getClassLoader()
    • getCompanyGroupId

      long getCompanyGroupId()
    • getCompanyId

      long getCompanyId()
    • getDataStrategy

      String getDataStrategy()
    • getDateRange

      DateRange getDateRange()
    • getDateRangeCriteria

      Criterion getDateRangeCriteria(String propertyName)
    • getDeletionSystemEventStagedModelTypes

      Set<StagedModelType> getDeletionSystemEventStagedModelTypes()
    • getEndDate

      Date getEndDate()
    • getExportDataElement

      Element getExportDataElement(ClassedModel classedModel)
    • getExportDataElement

      Element getExportDataElement(ClassedModel classedModel, String modelClassSimpleName)
    • getExportDataGroupElement

      Element getExportDataGroupElement(Class<? extends StagedModel> clazz)
    • getExportDataRootElement

      Element getExportDataRootElement()
    • getExportImportProcessId

      String getExportImportProcessId()
    • getGroupId

      long getGroupId()
    • getImportDataElement

      Element getImportDataElement(StagedModel stagedModel)
    • getImportDataElement

      Element getImportDataElement(String name, String attribute, String value)
    • getImportDataGroupElement

      Element getImportDataGroupElement(Class<? extends StagedModel> clazz)
    • getImportDataRootElement

      Element getImportDataRootElement()
    • getImportDataStagedModelElement

      Element getImportDataStagedModelElement(StagedModel stagedModel)
    • getLayoutIds

      long[] getLayoutIds()
    • getLayoutSetPrototypeUuid

      String getLayoutSetPrototypeUuid()
    • getLocks

      Map<String,Lock> getLocks()
    • getManifestSummary

      ManifestSummary getManifestSummary()
    • getMissingReferenceElement

      Element getMissingReferenceElement(ClassedModel classedModel)
    • getMissingReferencesElement

      Element getMissingReferencesElement()
    • getNewPrimaryKey

      Object getNewPrimaryKey(String className, Object newPrimaryKey)
    • getNewPrimaryKeysMap

      Map<?,?> getNewPrimaryKeysMap(Class<?> clazz)
    • getNewPrimaryKeysMap

      Map<?,?> getNewPrimaryKeysMap(String className)
    • getNewPrimaryKeysMaps

      Map<String,Map<?,?>> getNewPrimaryKeysMaps()
    • getParameterMap

      Map<String,String[]> getParameterMap()
    • getPermissions

      Map<String,List<KeyValuePair>> getPermissions()
    • getPlid

      long getPlid()
    • getPortletId

      String getPortletId()
    • getPrimaryKeys

      Set<String> getPrimaryKeys()
    • getReferenceDataElement

      Element getReferenceDataElement(Element parentElement, Class<?> clazz, long classPK)
    • getReferenceDataElement

      Element getReferenceDataElement(Element parentElement, Class<?> clazz, long groupId, String uuid)
    • getReferenceDataElement

      Element getReferenceDataElement(StagedModel parentStagedModel, Class<?> clazz, long classPK)
    • getReferenceDataElement

      Element getReferenceDataElement(StagedModel parentStagedModel, Class<?> clazz, long groupId, String uuid)
    • getReferenceDataElements

      List<Element> getReferenceDataElements(Element parentElement, Class<?> clazz, String referenceType)
    • getReferenceDataElements

      List<Element> getReferenceDataElements(StagedModel parentStagedModel, Class<?> clazz)
    • getReferenceDataElements

      List<Element> getReferenceDataElements(StagedModel parentStagedModel, Class<?> clazz, String referenceType)
    • getReferenceElement

      Element getReferenceElement(Element parentElement, Class<?> clazz, long groupId, String uuid, String referenceType)
    • getReferenceElement

      Element getReferenceElement(StagedModel parentStagedModel, String className, Serializable classPK)
    • getReferenceElement

      Element getReferenceElement(String className, Serializable classPK)
    • getReferenceElements

      List<Element> getReferenceElements(StagedModel parentStagedModel, Class<?> clazz)
    • getRootPortletId

      String getRootPortletId()
    • getScopedPrimaryKeys

      Set<String> 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

      long getUserId(String userUuid)
    • getUserIdStrategy

      UserIdStrategy getUserIdStrategy()
    • getUserPersonalSiteGroupId

      long getUserPersonalSiteGroupId()
    • getZipEntryAsByteArray

      byte[] getZipEntryAsByteArray(String path)
    • getZipEntryAsInputStream

      InputStream getZipEntryAsInputStream(String path)
    • getZipEntryAsObject

      Object getZipEntryAsObject(Element element, String path)
    • getZipEntryAsObject

      Object getZipEntryAsObject(String path)
    • getZipEntryAsString

      String getZipEntryAsString(String path)
    • getZipFolderEntries

      List<String> getZipFolderEntries(String path)
    • getZipReader

      ZipReader getZipReader()
    • getZipWriter

      ZipWriter getZipWriter()
    • hasDateRange

      boolean hasDateRange()
    • hasNotUniquePerLayout

      boolean hasNotUniquePerLayout(String dataKey)
    • hasPrimaryKey

      boolean hasPrimaryKey(Class<?> clazz, String primaryKey)
    • hasScopedPrimaryKey

      boolean hasScopedPrimaryKey(Class<?> clazz, String primaryKey)
    • 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

      void importLocks(Class<?> clazz, String key, String newKey) throws PortalException
      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

      void importPortalPermissions() throws PortalException
      Throws:
      PortalException
    • importPortletPermissions

      void importPortletPermissions(String resourceName) throws PortalException
      Throws:
      PortalException
    • isDataStrategyMirror

      boolean isDataStrategyMirror()
    • isDataStrategyMirrorWithOverwriting

      boolean isDataStrategyMirrorWithOverwriting()
    • isInitialPublication

      boolean isInitialPublication()
    • isMissingReference

      boolean isMissingReference(Element referenceElement)
    • isModelCounted

      boolean isModelCounted(String className, Serializable classPK)
    • isOriginalPrivateLayout

      default boolean isOriginalPrivateLayout()
    • isPathExportedInScope

      boolean isPathExportedInScope(String path)
    • isPathNotProcessed

      boolean isPathNotProcessed(String path)
    • isPathProcessed

      boolean isPathProcessed(String path)
    • isPerformDirectBinaryImport

      boolean isPerformDirectBinaryImport()
    • isPrivateLayout

      boolean isPrivateLayout()
    • isStagedModelCounted

      boolean isStagedModelCounted(StagedModel stagedModel)
    • isWithinDateRange

      boolean isWithinDateRange(Date modifiedDate)
    • putNotUniquePerLayout

      void putNotUniquePerLayout(String dataKey)
    • removePrimaryKey

      void removePrimaryKey(String path)
    • setClassLoader

      void setClassLoader(ClassLoader classLoader)
    • setCompanyGroupId

      void setCompanyGroupId(long companyGroupId)
    • setCompanyId

      void setCompanyId(long companyId)
    • setDataStrategy

      void setDataStrategy(String dataStrategy)
    • setEndDate

      void setEndDate(Date endDate)
    • setExportDataRootElement

      void setExportDataRootElement(Element exportDataRootElement)
    • setExportImportProcessId

      void setExportImportProcessId(String exportImportProcessId)
    • setGroupId

      void setGroupId(long groupId)
    • setImportDataElementCacheEnabled

      void setImportDataElementCacheEnabled(boolean importDataElementCacheEnabled)
    • setImportDataRootElement

      void setImportDataRootElement(Element importDataRootElement)
    • setLayoutIds

      void setLayoutIds(long[] layoutIds)
    • setLayoutSetPrototypeUuid

      void setLayoutSetPrototypeUuid(String layoutSetPrototypeUuid)
    • setManifestSummary

      void setManifestSummary(ManifestSummary manifestSummary)
    • setMissingReferencesElement

      void setMissingReferencesElement(Element missingReferencesElement)
    • setNewLayouts

      void setNewLayouts(List<Layout> newLayouts)
    • setOriginalPrivateLayout

      void setOriginalPrivateLayout(boolean originalPrivateLayout)
    • setParameterMap

      void setParameterMap(Map<String,String[]> parameterMap)
    • setPlid

      void setPlid(long plid)
    • setPortletId

      void setPortletId(String portletId)
    • setPrivateLayout

      void setPrivateLayout(boolean privateLayout)
    • setScopeGroupId

      void setScopeGroupId(long scopeGroupId)
    • setScopeLayoutUuid

      void setScopeLayoutUuid(String scopeLayoutUuid)
    • setScopeType

      void setScopeType(String scopeType)
    • setSourceCompanyGroupId

      void setSourceCompanyGroupId(long sourceCompanyGroupId)
    • setSourceCompanyId

      void setSourceCompanyId(long sourceCompanyId)
    • setSourceGroupId

      void setSourceGroupId(long sourceGroupId)
    • setSourceUserPersonalSiteGroupId

      void setSourceUserPersonalSiteGroupId(long sourceUserPersonalSiteGroupId)
    • setStartDate

      void setStartDate(Date startDate)
    • setType

      void setType(String type)
    • setUserIdStrategy

      void setUserIdStrategy(UserIdStrategy userIdStrategy)
    • setUserPersonalSiteGroupId

      void setUserPersonalSiteGroupId(long userPersonalSiteGroupId)
    • setZipReader

      void setZipReader(ZipReader zipReader)
    • setZipWriter

      void setZipWriter(ZipWriter zipWriter)
    • toXML

      String toXML(Object object)