Class LayoutServiceWrapper

Object
com.liferay.portal.kernel.service.LayoutServiceWrapper
All Implemented Interfaces:
BaseService, LayoutService, ServiceWrapper<LayoutService>

public class LayoutServiceWrapper extends Object implements LayoutService, ServiceWrapper<LayoutService>
Provides a wrapper for LayoutService.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • LayoutServiceWrapper

      public LayoutServiceWrapper()
    • LayoutServiceWrapper

      public LayoutServiceWrapper(LayoutService layoutService)
  • Method Details

    • addLayout

      public Layout addLayout(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, long classNameId, long classPK, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, String typeSettings, boolean hidden, boolean system, Map<Locale,String> friendlyURLMap, long masterLayoutPlid, ServiceContext serviceContext) throws PortalException
      Adds a layout with additional parameters.

      This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.

      Specified by:
      addLayout in interface LayoutService
      Parameters:
      externalReferenceCode - the layout's external reference code
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)
      classNameId - the class name ID of the entity
      classPK - the primary key of the entity
      localeNamesMap - the layout's locales and localized names
      localeTitlesMap - the layout's locales and localized titles
      descriptionMap - the layout's locales and localized descriptions
      keywordsMap - the layout's locales and localized keywords
      robotsMap - the layout's locales and localized robots
      type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.
      typeSettings - the settings to load the unicode properties object. See #fastLoad(String).
      hidden - whether the layout is hidden
      system - whether the layout is system
      friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize(String).
      masterLayoutPlid - the primary key of the master layout
      serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be used to specify whether site administrators can modify this page within their site.
      Returns:
      the layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • addLayout

      public Layout addLayout(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, String typeSettings, boolean hidden, Map<Locale,String> friendlyURLMap, long masterLayoutPlid, ServiceContext serviceContext) throws PortalException
      Adds a layout with additional parameters.

      This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.

      Specified by:
      addLayout in interface LayoutService
      Parameters:
      externalReferenceCode - the layout's external reference code
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)
      localeNamesMap - the layout's locales and localized names
      localeTitlesMap - the layout's locales and localized titles
      descriptionMap - the layout's locales and localized descriptions
      keywordsMap - the layout's locales and localized keywords
      robotsMap - the layout's locales and localized robots
      type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.
      typeSettings - the settings to load the unicode properties object. See #fastLoad(String).
      hidden - whether the layout is hidden
      friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize(String).
      masterLayoutPlid - the primary key of the master layout
      serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be used to specify whether site administrators can modify this page within their site.
      Returns:
      the layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • addLayout

      public Layout addLayout(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, String typeSettings, boolean hidden, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext) throws PortalException
      Adds a layout with additional parameters.

      This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.

      Specified by:
      addLayout in interface LayoutService
      Parameters:
      externalReferenceCode - the layout's external reference code
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)
      localeNamesMap - the layout's locales and localized names
      localeTitlesMap - the layout's locales and localized titles
      descriptionMap - the layout's locales and localized descriptions
      keywordsMap - the layout's locales and localized keywords
      robotsMap - the layout's locales and localized robots
      type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.
      typeSettings - the settings to load the unicode properties object. See #fastLoad(String).
      hidden - whether the layout is hidden
      friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize(String).
      serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be used to specify whether site administrators can modify this page within their site.
      Returns:
      the layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • addLayout

      public Layout addLayout(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext) throws PortalException
      Adds a layout with single entry maps for name, title, and description to the default locale.

      This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.

      Specified by:
      addLayout in interface LayoutService
      Parameters:
      externalReferenceCode - the layout's external reference code
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)
      name - the layout's locales and localized names
      title - the layout's locales and localized titles
      description - the layout's locales and localized descriptions
      type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.
      hidden - whether the layout is hidden
      friendlyURL - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize(String).
      serviceContext - the service context to be applied. Must set the UUID for the layout. Can specify the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be used to specify whether site administrators can modify this page within their site.
      Returns:
      the layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • addTempFileEntry

      public FileEntry addTempFileEntry(long groupId, String folderName, String fileName, InputStream inputStream, String mimeType) throws PortalException
      Specified by:
      addTempFileEntry in interface LayoutService
      Throws:
      PortalException
    • copyLayout

      public Layout copyLayout(long groupId, boolean privateLayout, Map<Locale,String> localeNamesMap, boolean hidden, boolean system, boolean copyPermissions, long sourcePlid, ServiceContext serviceContext) throws PortalException
      Specified by:
      copyLayout in interface LayoutService
      Throws:
      PortalException
    • deleteLayout

      public void deleteLayout(long groupId, boolean privateLayout, long layoutId, ServiceContext serviceContext) throws PortalException
      Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.
      Specified by:
      deleteLayout in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      layoutId - the layout ID of the layout
      serviceContext - the service context to be applied
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • deleteLayout

      public void deleteLayout(long plid, ServiceContext serviceContext) throws PortalException
      Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.
      Specified by:
      deleteLayout in interface LayoutService
      Parameters:
      plid - the primary key of the layout
      serviceContext - the service context to be applied
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • deleteLayout

      public void deleteLayout(String externalReferenceCode, long groupId) throws PortalException
      Specified by:
      deleteLayout in interface LayoutService
      Throws:
      PortalException
    • deleteTempFileEntry

      public void deleteTempFileEntry(long groupId, String folderName, String fileName) throws PortalException
      Specified by:
      deleteTempFileEntry in interface LayoutService
      Throws:
      PortalException
    • fetchFirstLayout

      public Layout fetchFirstLayout(long groupId, boolean privateLayout, boolean published)
      Specified by:
      fetchFirstLayout in interface LayoutService
    • fetchLayout

      public Layout fetchLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException
      Specified by:
      fetchLayout in interface LayoutService
      Throws:
      PortalException
    • fetchLayoutByExternalReferenceCode

      public Layout fetchLayoutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Specified by:
      fetchLayoutByExternalReferenceCode in interface LayoutService
      Throws:
      PortalException
    • fetchLayoutPlid

      public long fetchLayoutPlid(String uuid, long groupId, boolean privateLayout) throws PortalException
      Specified by:
      fetchLayoutPlid in interface LayoutService
      Throws:
      PortalException
    • getAncestorLayouts

      public List<Layout> getAncestorLayouts(long plid) throws PortalException
      Returns all the ancestor layouts of the layout.
      Specified by:
      getAncestorLayouts in interface LayoutService
      Parameters:
      plid - the primary key of the layout
      Returns:
      the ancestor layouts of the layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getControlPanelLayoutPlid

      public long getControlPanelLayoutPlid() throws PortalException
      Returns the control panel layout's plid.
      Specified by:
      getControlPanelLayoutPlid in interface LayoutService
      Returns:
      the control panel layout's plid
      Throws:
      PortalException - if a portal exception is occured
      PortalException
    • getDefaultPlid

      public long getDefaultPlid(long groupId, boolean privateLayout)
      Returns primary key of the matching default layout for the group.
      Specified by:
      getDefaultPlid in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      Returns:
      the primary key of the default layout for the group; LayoutConstants#DEFAULT_PLID) otherwise
    • getDefaultPlid

      public long getDefaultPlid(long groupId, long scopeGroupId, boolean privateLayout, String portletId) throws PortalException
      Returns the primary key of the default layout for the group.
      Specified by:
      getDefaultPlid in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      scopeGroupId - the primary key of the scope group. See ServiceContext.getScopeGroupId().
      privateLayout - whether the layout is private to the group
      portletId - the primary key of the portlet
      Returns:
      Returns the primary key of the default layout group; LayoutConstants#DEFAULT_PLID otherwise
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getDefaultPlid

      public long getDefaultPlid(long groupId, long scopeGroupId, String portletId) throws PortalException
      Specified by:
      getDefaultPlid in interface LayoutService
      Throws:
      PortalException
    • getLayoutByExternalReferenceCode

      public Layout getLayoutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Specified by:
      getLayoutByExternalReferenceCode in interface LayoutService
      Throws:
      PortalException
    • getLayoutByUuidAndGroupId

      public Layout getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout) throws PortalException
      Returns the layout matching the UUID, group, and privacy.
      Specified by:
      getLayoutByUuidAndGroupId in interface LayoutService
      Parameters:
      uuid - the layout's UUID
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      Returns:
      the matching layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getLayoutName

      public String getLayoutName(long groupId, boolean privateLayout, long layoutId, String languageId) throws PortalException
      Returns the name of the layout.
      Specified by:
      getLayoutName in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      layoutId - the layout ID of the layout
      languageId - the primary key of the language. For more information See Locale.
      Returns:
      the layout's name
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getLayoutPlid

      public long getLayoutPlid(String uuid, long groupId, boolean privateLayout) throws PortalException
      Returns the layout's plid that matches the parameters.
      Specified by:
      getLayoutPlid in interface LayoutService
      Parameters:
      uuid - the layout's UUID
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      Returns:
      the matching layout's plid
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getLayoutReferences

      public LayoutReference[] getLayoutReferences(long companyId, String portletId, String preferencesKey, String preferencesValue)
      Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences.
      Specified by:
      getLayoutReferences in interface LayoutService
      Parameters:
      companyId - the primary key of the company
      portletId - the primary key of the portlet
      preferencesKey - the portlet's preference key
      preferencesValue - the portlet's preference value
      Returns:
      the layout references of the matching layouts
    • getLayouts

      public List<Layout> getLayouts(long groupId, boolean privateLayout)
      Specified by:
      getLayouts in interface LayoutService
    • getLayouts

      public List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId) throws PortalException
      Specified by:
      getLayouts in interface LayoutService
      Throws:
      PortalException
    • getLayouts

      public List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end) throws PortalException
      Specified by:
      getLayouts in interface LayoutService
      Throws:
      PortalException
    • getLayouts

      public List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, int start, int end) throws PortalException
      Specified by:
      getLayouts in interface LayoutService
      Throws:
      PortalException
    • getLayouts

      public List<Layout> getLayouts(long groupId, boolean privateLayout, String type) throws PortalException
      Specified by:
      getLayouts in interface LayoutService
      Throws:
      PortalException
    • getLayouts

      public List<Layout> getLayouts(long groupId, boolean privateLayout, String type, int start, int end) throws PortalException
      Specified by:
      getLayouts in interface LayoutService
      Throws:
      PortalException
    • getLayouts

      public List<Layout> getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
      Specified by:
      getLayouts in interface LayoutService
      Throws:
      PortalException
    • getLayouts

      public List<Layout> getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
      Specified by:
      getLayouts in interface LayoutService
      Throws:
      PortalException
    • getLayouts

      public List<Layout> getLayouts(long groupId, String type)
      Specified by:
      getLayouts in interface LayoutService
    • getLayouts

      public List<Layout> getLayouts(long groupId, String type, int start, int end)
      Specified by:
      getLayouts in interface LayoutService
    • getLayoutsCount

      public int getLayoutsCount(long groupId, boolean privateLayout)
      Specified by:
      getLayoutsCount in interface LayoutService
    • getLayoutsCount

      public int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId)
      Specified by:
      getLayoutsCount in interface LayoutService
    • getLayoutsCount

      public int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId, int priority)
      Specified by:
      getLayoutsCount in interface LayoutService
    • getLayoutsCount

      public int getLayoutsCount(long groupId, boolean privateLayout, String type)
      Specified by:
      getLayoutsCount in interface LayoutService
    • getLayoutsCount

      public int getLayoutsCount(long groupId, boolean privateLayout, String keywords, String[] types) throws PortalException
      Specified by:
      getLayoutsCount in interface LayoutService
      Throws:
      PortalException
    • getLayoutsCount

      public int getLayoutsCount(long groupId, boolean privateLayout, String keywords, String[] types, int[] statuses) throws PortalException
      Specified by:
      getLayoutsCount in interface LayoutService
      Throws:
      PortalException
    • getLayoutsCount

      public int getLayoutsCount(long groupId, String type)
      Specified by:
      getLayoutsCount in interface LayoutService
    • getOSGiServiceIdentifier

      public String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Specified by:
      getOSGiServiceIdentifier in interface LayoutService
      Returns:
      the OSGi service identifier
    • getTempFileNames

      public String[] getTempFileNames(long groupId, String folderName) throws PortalException
      Specified by:
      getTempFileNames in interface LayoutService
      Throws:
      PortalException
    • hasLayout

      public boolean hasLayout(String uuid, long groupId, boolean privateLayout) throws PortalException
      Returns true if there is a matching layout with the UUID, group, and privacy.
      Specified by:
      hasLayout in interface LayoutService
      Parameters:
      uuid - the layout's UUID
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      Returns:
      true if the layout is found; false otherwise
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • hasPortletId

      public boolean hasPortletId(long plid, String portletId) throws PortalException
      Specified by:
      hasPortletId in interface LayoutService
      Throws:
      PortalException
    • publishLayout

      public Layout publishLayout(long plid) throws Exception
      Specified by:
      publishLayout in interface LayoutService
      Throws:
      Exception
    • schedulePublishToLive

      public void schedulePublishToLive(long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description) throws PortalException
      Schedules a range of layouts to be published.
      Specified by:
      schedulePublishToLive in interface LayoutService
      Parameters:
      sourceGroupId - the primary key of the source group
      targetGroupId - the primary key of the target group
      privateLayout - whether the layout is private to the group
      layoutIds - the layouts considered for publishing, specified by the layout IDs
      parameterMap - the mapping of parameters indicating which information will be used. See PortletDataHandlerKeys.
      groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
      cronText - the cron text. See CronTextUtil.getCronText(javax.portlet.PortletRequest, java.util.Calendar, boolean, int)
      schedulerStartDate - the scheduler start date
      schedulerEndDate - the scheduler end date
      description - the scheduler description
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • schedulePublishToRemote

      public void schedulePublishToRemote(long sourceGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description) throws PortalException
      Schedules a range of layouts to be stored.
      Specified by:
      schedulePublishToRemote in interface LayoutService
      Parameters:
      sourceGroupId - the primary key of the source group
      privateLayout - whether the layout is private to the group
      layoutIdMap - the layouts considered for publishing, specified by the layout IDs and booleans indicating whether they have children
      parameterMap - the mapping of parameters indicating which information will be used. See PortletDataHandlerKeys.
      remoteAddress - the remote address
      remotePort - the remote port
      remotePathContext - the remote path context
      secureConnection - whether the connection is secure
      remoteGroupId - the primary key of the remote group
      remotePrivateLayout - whether remote group's layout is private
      startDate - the start date
      endDate - the end date
      groupName - the group name. Optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
      cronText - the cron text. See CronTextUtil.getCronText(javax.portlet.PortletRequest, java.util.Calendar, boolean, int)
      schedulerStartDate - the scheduler start date
      schedulerEndDate - the scheduler end date
      description - the scheduler description
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • setLayouts

      public void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds, ServiceContext serviceContext) throws PortalException
      Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.
      Specified by:
      setLayouts in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      parentLayoutId - the layout ID of the parent layout
      layoutIds - the primary keys of the layouts
      serviceContext - the service context to be applied
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • unschedulePublishToLive

      public void unschedulePublishToLive(long groupId, String jobName, String groupName) throws PortalException
      Deletes the job from the scheduler's queue.
      Specified by:
      unschedulePublishToLive in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      jobName - the job name
      groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • unschedulePublishToRemote

      public void unschedulePublishToRemote(long groupId, String jobName, String groupName) throws PortalException
      Deletes the job from the scheduler's persistent queue.
      Specified by:
      unschedulePublishToRemote in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      jobName - the job name
      groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updateIconImage

      public Layout updateIconImage(long plid, byte[] bytes) throws PortalException
      Specified by:
      updateIconImage in interface LayoutService
      Throws:
      PortalException
    • updateLayout

      public Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, boolean hidden, Map<Locale,String> friendlyURLMap, boolean hasIconImage, byte[] iconBytes, long styleBookEntryId, long faviconFileEntryId, long masterLayoutPlid, ServiceContext serviceContext) throws PortalException
      Updates the layout with additional parameters.
      Specified by:
      updateLayout in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      layoutId - the layout ID of the layout
      parentLayoutId - the layout ID of the layout's new parent layout
      localeNamesMap - the layout's locales and localized names
      localeTitlesMap - the layout's locales and localized titles
      descriptionMap - the locales and localized descriptions to merge (optionally null)
      keywordsMap - the locales and localized keywords to merge (optionally null)
      robotsMap - the locales and localized robots to merge (optionally null)
      type - the layout's new type (optionally LayoutConstants#TYPE_PORTLET)
      hidden - whether the layout is hidden
      friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize(String).
      hasIconImage - if the layout has a custom icon image
      iconBytes - the byte array of the layout's new icon image
      styleBookEntryId - the primary key of the style book entry
      faviconFileEntryId - the file entry ID of the layout's new favicon
      masterLayoutPlid - the primary key of the master layout
      serviceContext - the service context to be applied. Can set the modification date and expando bridge attributes for the layout.
      Returns:
      the updated layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updateLayout

      public Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings) throws PortalException
      Updates the layout replacing its type settings.
      Specified by:
      updateLayout in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      layoutId - the layout ID of the layout
      typeSettings - the settings to load the unicode properties object. See #fastLoad(String).
      Returns:
      the updated layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updateLookAndFeel

      public Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css) throws PortalException
      Updates the look and feel of the layout.
      Specified by:
      updateLookAndFeel in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      layoutId - the layout ID of the layout
      themeId - the primary key of the layout's new theme
      colorSchemeId - the primary key of the layout's new color scheme
      css - the layout's new CSS
      Returns:
      the updated layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updateName

      public Layout updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId) throws PortalException
      Updates the name of the layout matching the group, layout ID, and privacy.
      Specified by:
      updateName in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      layoutId - the layout ID of the layout
      name - the layout's new name
      languageId - the primary key of the language. For more information see Locale.
      Returns:
      the updated layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updateName

      public Layout updateName(long plid, String name, String languageId) throws PortalException
      Updates the name of the layout matching the primary key.
      Specified by:
      updateName in interface LayoutService
      Parameters:
      plid - the primary key of the layout
      name - the name to be assigned
      languageId - the primary key of the language. For more information see Locale.
      Returns:
      the updated layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updateParentLayoutId

      public Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId) throws PortalException
      Updates the parent layout ID of the layout matching the group, layout ID, and privacy.
      Specified by:
      updateParentLayoutId in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      layoutId - the layout ID of the layout
      parentLayoutId - the layout ID to be assigned to the parent layout
      Returns:
      the matching layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updateParentLayoutId

      public Layout updateParentLayoutId(long plid, long parentPlid) throws PortalException
      Updates the parent layout ID of the layout matching the primary key. If a layout matching the parent primary key is found, the layout ID of that layout is assigned, otherwise LayoutConstants#DEFAULT_PARENT_LAYOUT_ID is assigned.
      Specified by:
      updateParentLayoutId in interface LayoutService
      Parameters:
      plid - the primary key of the layout
      parentPlid - the primary key of the parent layout
      Returns:
      the layout matching the primary key
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updateParentLayoutIdAndPriority

      public Layout updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority) throws PortalException
      Updates the parent layout ID and priority of the layout.
      Specified by:
      updateParentLayoutIdAndPriority in interface LayoutService
      Parameters:
      plid - the primary key of the layout
      parentPlid - the primary key of the parent layout
      priority - the layout's new priority
      Returns:
      the layout matching the primary key
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updatePriority

      public Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority) throws PortalException
      Updates the priority of the layout matching the group, layout ID, and privacy.
      Specified by:
      updatePriority in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      layoutId - the layout ID of the layout
      priority - the layout's new priority
      Returns:
      the updated layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updatePriority

      public Layout updatePriority(long groupId, boolean privateLayout, long layoutId, long nextLayoutId, long previousLayoutId) throws PortalException
      Updates the priority of the layout matching the group, layout ID, and privacy, setting the layout's priority based on the priorities of the next and previous layouts.
      Specified by:
      updatePriority in interface LayoutService
      Parameters:
      groupId - the primary key of the group
      privateLayout - whether the layout is private to the group
      layoutId - the layout ID of the layout
      nextLayoutId - the layout ID of the next layout
      previousLayoutId - the layout ID of the previous layout
      Returns:
      the updated layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updatePriority

      public Layout updatePriority(long plid, int priority) throws PortalException
      Updates the priority of the layout matching the primary key.
      Specified by:
      updatePriority in interface LayoutService
      Parameters:
      plid - the primary key of the layout
      priority - the layout's new priority
      Returns:
      the updated layout
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updateType

      public Layout updateType(long plid, String type) throws PortalException
      Specified by:
      updateType in interface LayoutService
      Throws:
      PortalException
    • getWrappedService

      public LayoutService getWrappedService()
      Specified by:
      getWrappedService in interface ServiceWrapper<LayoutService>
    • setWrappedService

      public void setWrappedService(LayoutService layoutService)
      Specified by:
      setWrappedService in interface ServiceWrapper<LayoutService>