Liferay 6.1.2-ce-ga3

com.liferay.portal.service.impl
Class LayoutLocalServiceImpl

java.lang.Object
  extended by com.liferay.portal.service.BaseLocalServiceImpl
      extended by com.liferay.portal.service.base.LayoutLocalServiceBaseImpl
          extended by com.liferay.portal.service.impl.LayoutLocalServiceImpl
All Implemented Interfaces:
IdentifiableBean, BaseLocalService, LayoutLocalService, PersistedModelLocalService

public class LayoutLocalServiceImpl
extends LayoutLocalServiceBaseImpl

The implementation of the layout local service.


Field Summary
protected  LayoutLocalServiceHelper layoutLocalServiceHelper
           
 
Fields inherited from class com.liferay.portal.service.base.LayoutLocalServiceBaseImpl
accountLocalService, accountPersistence, accountService, addressLocalService, addressPersistence, addressService, browserTrackerLocalService, browserTrackerPersistence, classNameLocalService, classNamePersistence, classNameService, clusterGroupLocalService, clusterGroupPersistence, cmisRepositoryLocalService, companyLocalService, companyPersistence, companyService, contactLocalService, contactPersistence, contactService, counterLocalService, countryPersistence, countryService, emailAddressLocalService, emailAddressPersistence, emailAddressService, expandoValueLocalService, expandoValuePersistence, expandoValueService, groupFinder, groupLocalService, groupPersistence, groupService, imageLocalService, imagePersistence, imageService, journalArticleFinder, journalArticleLocalService, journalArticlePersistence, journalArticleService, journalContentSearchLocalService, journalContentSearchPersistence, layoutBranchLocalService, layoutBranchPersistence, layoutBranchService, layoutFinder, layoutLocalService, layoutPersistence, layoutPrototypeLocalService, layoutPrototypePersistence, layoutPrototypeService, layoutRevisionLocalService, layoutRevisionPersistence, layoutRevisionService, layoutService, layoutSetBranchLocalService, layoutSetBranchPersistence, layoutSetBranchService, layoutSetLocalService, layoutSetPersistence, layoutSetPrototypeLocalService, layoutSetPrototypePersistence, layoutSetPrototypeService, layoutSetService, layoutTemplateLocalService, listTypePersistence, listTypeService, lockFinder, lockLocalService, lockPersistence, mbMessageFinder, mbMessageLocalService, mbMessagePersistence, mbMessageService, mdrRuleGroupInstanceLocalService, mdrRuleGroupInstancePersistence, mdrRuleGroupInstanceService, membershipRequestLocalService, membershipRequestPersistence, membershipRequestService, organizationFinder, organizationLocalService, organizationPersistence, organizationService, orgGroupPermissionFinder, orgGroupPermissionPersistence, orgGroupRolePersistence, orgLaborLocalService, orgLaborPersistence, orgLaborService, passwordPolicyFinder, passwordPolicyLocalService, passwordPolicyPersistence, passwordPolicyRelLocalService, passwordPolicyRelPersistence, passwordPolicyService, passwordTrackerLocalService, passwordTrackerPersistence, permissionFinder, permissionLocalService, permissionPersistence, permissionService, persistedModelLocalServiceRegistry, phoneLocalService, phonePersistence, phoneService, pluginSettingLocalService, pluginSettingPersistence, pluginSettingService, portalLocalService, portalPreferencesLocalService, portalPreferencesPersistence, portalService, portletItemLocalService, portletItemPersistence, portletLocalService, portletPersistence, portletPreferencesFinder, portletPreferencesLocalService, portletPreferencesPersistence, portletPreferencesService, portletService, quartzLocalService, ratingsStatsFinder, ratingsStatsLocalService, ratingsStatsPersistence, regionPersistence, regionService, releaseLocalService, releasePersistence, repositoryEntryLocalService, repositoryEntryPersistence, repositoryLocalService, repositoryPersistence, repositoryService, resourceActionLocalService, resourceActionPersistence, resourceBlockFinder, resourceBlockLocalService, resourceBlockPermissionLocalService, resourceBlockPermissionPersistence, resourceBlockPersistence, resourceBlockService, resourceCodeLocalService, resourceCodePersistence, resourceFinder, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, resourcePermissionService, resourcePersistence, resourceService, resourceTypePermissionFinder, resourceTypePermissionLocalService, resourceTypePermissionPersistence, roleFinder, roleLocalService, rolePersistence, roleService, serviceComponentLocalService, serviceComponentPersistence, shardLocalService, shardPersistence, subscriptionLocalService, subscriptionPersistence, teamFinder, teamLocalService, teamPersistence, teamService, themeLocalService, themeService, ticketLocalService, ticketPersistence, userFinder, userGroupFinder, userGroupGroupRoleLocalService, userGroupGroupRolePersistence, userGroupGroupRoleService, userGroupLocalService, userGroupPersistence, userGroupRoleFinder, userGroupRoleLocalService, userGroupRolePersistence, userGroupRoleService, userGroupService, userIdMapperLocalService, userIdMapperPersistence, userLocalService, userNotificationEventLocalService, userNotificationEventPersistence, userPersistence, userService, userTrackerLocalService, userTrackerPathLocalService, userTrackerPathPersistence, userTrackerPersistence, virtualHostLocalService, virtualHostPersistence, webDAVPropsLocalService, webDAVPropsPersistence, websiteLocalService, websitePersistence, websiteService, workflowDefinitionLinkLocalService, workflowDefinitionLinkPersistence, workflowInstanceLinkLocalService, workflowInstanceLinkPersistence
 
Constructor Summary
LayoutLocalServiceImpl()
           
 
Method Summary
 Layout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> nameMap, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)
          Adds a layout with additional parameters.
 Layout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)
          Adds a layout.
 void deleteLayout(Layout layout, boolean updateLayoutSet, ServiceContext serviceContext)
          Deletes the layout, its child layouts, and its associated resources.
 void deleteLayout(long groupId, boolean privateLayout, long layoutId, ServiceContext serviceContext)
          Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.
 void deleteLayout(long plid, ServiceContext serviceContext)
          Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.
 void deleteLayouts(long groupId, boolean privateLayout, ServiceContext serviceContext)
          Deletes the group's private or non-private layouts, also deleting the layouts' child layouts, and associated resources.
 byte[] exportLayouts(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate)
          Exports layouts with the primary keys and criteria as a byte array.
 byte[] exportLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, Date startDate, Date endDate)
          Exports all layouts that match the criteria as a byte array.
 File exportLayoutsAsFile(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate)
          Exports the layouts that match the primary keys and criteria as a file.
 byte[] exportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)
          Exports the portlet information (categories, permissions, ... etc.) as a byte array.
 File exportPortletInfoAsFile(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)
          Exports the portlet information (categories, permissions, ... etc.) as a file.
 Layout fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId)
           
 Layout fetchLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)
           
static String getCounterName(long groupId, boolean privateLayout)
          Returns the object counter's name.
 long getDefaultPlid(long groupId)
          Returns the primary key of the default layout for the group
 long getDefaultPlid(long groupId, boolean privateLayout)
          Returns primary key of the matching default layout for the group
 long getDefaultPlid(long groupId, boolean privateLayout, String portletId)
          Returns primary key of the default portlet layout for the group
 Layout getFriendlyURLLayout(long groupId, boolean privateLayout, String friendlyURL)
          Returns the layout for the friendly URL
 Layout getLayout(long groupId, boolean privateLayout, long layoutId)
          Returns the layout matching the primary key, group, and privacy; throws a NoSuchLayoutException otherwise.
 Layout getLayoutByIconImageId(long iconImageId)
          Returns the layout for the icon image; throws a NoSuchLayoutException otherwise.
 List<Layout> getLayouts(long groupId, boolean privateLayout)
          Returns all the layouts belonging to the group.
 List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId)
          Returns all the layouts belonging to the group that are children of the parent layout.
 List<Layout> getLayouts(long groupId, boolean privateLayout, long[] layoutIds)
          Returns all the layouts that match the layout IDs and belong to the group.
 List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end)
          Returns a range of all the layouts belonging to the group that are children of the parent layout.
 List<Layout> getLayouts(long groupId, boolean privateLayout, String type)
          Returns all the layouts that match the type and belong to the group.
 LayoutReference[] getLayouts(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.
 int getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid)
           
 int getLayoutsCount(Group group, boolean privateLayout)
           
 int getLayoutsCount(Group group, boolean privateLayout, boolean includeUserGroups)
           
 int getLayoutsCount(User user, boolean privateLayout)
           
 int getLayoutsCount(User user, boolean privateLayout, boolean includeUserGroups)
           
 long getNextLayoutId(long groupId, boolean privateLayout)
          Returns the primary key to use for the next layout.
 List<Layout> getNullFriendlyURLLayouts()
          Returns all the layouts whose friendly URLs are null
 List<Layout> getScopeGroupLayouts(long groupId, boolean privateLayout)
          Returns all the layouts within scope of the group
 boolean hasLayouts(Group group, boolean privateLayout)
           
 boolean hasLayouts(Group group, boolean privateLayout, boolean includeUserGroups)
           
 boolean hasLayouts(long groupId, boolean privateLayout, long parentLayoutId)
          Returns true if the group has any layouts; false otherwise.
 boolean hasLayouts(User user, boolean privateLayout)
           
 boolean hasLayouts(User user, boolean privateLayout, boolean includeUserGroups)
           
 boolean hasLayoutSetPrototypeLayout(long layoutSetPrototypeId, String layoutUuid)
           
 boolean hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid, String layoutUuid)
           
 void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes)
          Imports the layouts from the byte array.
 void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)
          Imports the layouts from the file.
 void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is)
          Imports the layouts from the input stream.
 void importPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)
          Imports the portlet information (categories, permissions, ... etc.) from the file.
 void importPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is)
          Imports the portlet information (categories, permissions, ... etc.) from the input stream.
 void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds, ServiceContext serviceContext)
          Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.
 Layout updateFriendlyURL(long plid, String friendlyURL)
          Updates the friendly URL of the layout.
 Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> nameMap, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, boolean hidden, String friendlyURL, Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext)
          Updates the layout.
 Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings)
          Updates the layout replacing its type settings.
 Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css, boolean wapTheme)
          Updates the look and feel of the layout.
 Layout updateName(Layout layout, String name, String languageId)
          Updates the name of the layout.
 Layout updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId)
          Updates the name of the layout matching the group, layout ID, and privacy.
 Layout updateName(long plid, String name, String languageId)
          Updates the name of the layout matching the primary key.
 Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
          Updates the parent layout ID of the layout matching the group, layout ID, and privacy.
 Layout updateParentLayoutId(long plid, long parentPlid)
          Updates the parent layout ID of the layout matching the primary key.
 void updatePriorities(long groupId, boolean privateLayout)
          Updates the priorities of the layouts.
 Layout updatePriority(Layout layout, int priority)
          Updates the priority of the layout.
 Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)
          Updates the priority of the layout matching the group, layout ID, and privacy.
 Layout updatePriority(long plid, int priority)
          Updates the priority of the layout matching the primary key.
 void updateScopedPortletNames(long groupId, boolean privateLayout, long layoutId, Map<Locale,String> nameMap, List<Locale> nameMapModifiedLocales)
          Deprecated. As of 6.2.0, with no direct replacement
 void updateScopedPortletNames(long groupId, boolean privateLayout, long layoutId, String name, String languageId)
          Deprecated. As of 6.2.0, with no direct replacement
protected  void validateTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
           
 
Methods inherited from class com.liferay.portal.service.base.LayoutLocalServiceBaseImpl
addLayout, afterPropertiesSet, createLayout, deleteLayout, deleteLayout, destroy, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, fetchLayout, getAccountLocalService, getAccountPersistence, getAccountService, getAddressLocalService, getAddressPersistence, getAddressService, getBeanIdentifier, getBrowserTrackerLocalService, getBrowserTrackerPersistence, getClassNameLocalService, getClassNamePersistence, getClassNameService, getClusterGroupLocalService, getClusterGroupPersistence, getCMISRepositoryLocalService, getCompanyLocalService, getCompanyPersistence, getCompanyService, getContactLocalService, getContactPersistence, getContactService, getCounterLocalService, getCountryPersistence, getCountryService, getEmailAddressLocalService, getEmailAddressPersistence, getEmailAddressService, getExpandoValueLocalService, getExpandoValuePersistence, getExpandoValueService, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getImageLocalService, getImagePersistence, getImageService, getJournalArticleFinder, getJournalArticleLocalService, getJournalArticlePersistence, getJournalArticleService, getJournalContentSearchLocalService, getJournalContentSearchPersistence, getLayout, getLayoutBranchLocalService, getLayoutBranchPersistence, getLayoutBranchService, getLayoutByUuidAndGroupId, getLayoutFinder, getLayoutLocalService, getLayoutPersistence, getLayoutPrototypeLocalService, getLayoutPrototypePersistence, getLayoutPrototypeService, getLayoutRevisionLocalService, getLayoutRevisionPersistence, getLayoutRevisionService, getLayouts, getLayoutsCount, getLayoutService, getLayoutSetBranchLocalService, getLayoutSetBranchPersistence, getLayoutSetBranchService, getLayoutSetLocalService, getLayoutSetPersistence, getLayoutSetPrototypeLocalService, getLayoutSetPrototypePersistence, getLayoutSetPrototypeService, getLayoutSetService, getLayoutTemplateLocalService, getListTypePersistence, getListTypeService, getLockFinder, getLockLocalService, getLockPersistence, getMBMessageFinder, getMBMessageLocalService, getMBMessagePersistence, getMBMessageService, getMDRRuleGroupInstanceLocalService, getMDRRuleGroupInstancePersistence, getMDRRuleGroupInstanceService, getMembershipRequestLocalService, getMembershipRequestPersistence, getMembershipRequestService, getModelClass, getModelClassName, getOrganizationFinder, getOrganizationLocalService, getOrganizationPersistence, getOrganizationService, getOrgGroupPermissionFinder, getOrgGroupPermissionPersistence, getOrgGroupRolePersistence, getOrgLaborLocalService, getOrgLaborPersistence, getOrgLaborService, getPasswordPolicyFinder, getPasswordPolicyLocalService, getPasswordPolicyPersistence, getPasswordPolicyRelLocalService, getPasswordPolicyRelPersistence, getPasswordPolicyService, getPasswordTrackerLocalService, getPasswordTrackerPersistence, getPermissionFinder, getPermissionLocalService, getPermissionPersistence, getPermissionService, getPersistedModel, getPhoneLocalService, getPhonePersistence, getPhoneService, getPluginSettingLocalService, getPluginSettingPersistence, getPluginSettingService, getPortalLocalService, getPortalPreferencesLocalService, getPortalPreferencesPersistence, getPortalService, getPortletItemLocalService, getPortletItemPersistence, getPortletLocalService, getPortletPersistence, getPortletPreferencesFinder, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getPortletPreferencesService, getPortletService, getQuartzLocalService, getRatingsStatsFinder, getRatingsStatsLocalService, getRatingsStatsPersistence, getRegionPersistence, getRegionService, getReleaseLocalService, getReleasePersistence, getRepositoryEntryLocalService, getRepositoryEntryPersistence, getRepositoryLocalService, getRepositoryPersistence, getRepositoryService, getResourceActionLocalService, getResourceActionPersistence, getResourceBlockFinder, getResourceBlockLocalService, getResourceBlockPermissionLocalService, getResourceBlockPermissionPersistence, getResourceBlockPersistence, getResourceBlockService, getResourceCodeLocalService, getResourceCodePersistence, getResourceFinder, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getResourcePermissionService, getResourcePersistence, getResourceService, getResourceTypePermissionFinder, getResourceTypePermissionLocalService, getResourceTypePermissionPersistence, getRoleFinder, getRoleLocalService, getRolePersistence, getRoleService, getServiceComponentLocalService, getServiceComponentPersistence, getShardLocalService, getShardPersistence, getSubscriptionLocalService, getSubscriptionPersistence, getTeamFinder, getTeamLocalService, getTeamPersistence, getTeamService, getThemeLocalService, getThemeService, getTicketLocalService, getTicketPersistence, getUserFinder, getUserGroupFinder, getUserGroupGroupRoleLocalService, getUserGroupGroupRolePersistence, getUserGroupGroupRoleService, getUserGroupLocalService, getUserGroupPersistence, getUserGroupRoleFinder, getUserGroupRoleLocalService, getUserGroupRolePersistence, getUserGroupRoleService, getUserGroupService, getUserIdMapperLocalService, getUserIdMapperPersistence, getUserLocalService, getUserNotificationEventLocalService, getUserNotificationEventPersistence, getUserPersistence, getUserService, getUserTrackerLocalService, getUserTrackerPathLocalService, getUserTrackerPathPersistence, getUserTrackerPersistence, getVirtualHostLocalService, getVirtualHostPersistence, getWebDAVPropsLocalService, getWebDAVPropsPersistence, getWebsiteLocalService, getWebsitePersistence, getWebsiteService, getWorkflowDefinitionLinkLocalService, getWorkflowDefinitionLinkPersistence, getWorkflowInstanceLinkLocalService, getWorkflowInstanceLinkPersistence, runSQL, setAccountLocalService, setAccountPersistence, setAccountService, setAddressLocalService, setAddressPersistence, setAddressService, setBeanIdentifier, setBrowserTrackerLocalService, setBrowserTrackerPersistence, setClassNameLocalService, setClassNamePersistence, setClassNameService, setClusterGroupLocalService, setClusterGroupPersistence, setCMISRepositoryLocalService, setCompanyLocalService, setCompanyPersistence, setCompanyService, setContactLocalService, setContactPersistence, setContactService, setCounterLocalService, setCountryPersistence, setCountryService, setEmailAddressLocalService, setEmailAddressPersistence, setEmailAddressService, setExpandoValueLocalService, setExpandoValuePersistence, setExpandoValueService, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setImageLocalService, setImagePersistence, setImageService, setJournalArticleFinder, setJournalArticleLocalService, setJournalArticlePersistence, setJournalArticleService, setJournalContentSearchLocalService, setJournalContentSearchPersistence, setLayoutBranchLocalService, setLayoutBranchPersistence, setLayoutBranchService, setLayoutFinder, setLayoutLocalService, setLayoutPersistence, setLayoutPrototypeLocalService, setLayoutPrototypePersistence, setLayoutPrototypeService, setLayoutRevisionLocalService, setLayoutRevisionPersistence, setLayoutRevisionService, setLayoutService, setLayoutSetBranchLocalService, setLayoutSetBranchPersistence, setLayoutSetBranchService, setLayoutSetLocalService, setLayoutSetPersistence, setLayoutSetPrototypeLocalService, setLayoutSetPrototypePersistence, setLayoutSetPrototypeService, setLayoutSetService, setLayoutTemplateLocalService, setListTypePersistence, setListTypeService, setLockFinder, setLockLocalService, setLockPersistence, setMBMessageFinder, setMBMessageLocalService, setMBMessagePersistence, setMBMessageService, setMDRRuleGroupInstanceLocalService, setMDRRuleGroupInstancePersistence, setMDRRuleGroupInstanceService, setMembershipRequestLocalService, setMembershipRequestPersistence, setMembershipRequestService, setOrganizationFinder, setOrganizationLocalService, setOrganizationPersistence, setOrganizationService, setOrgGroupPermissionFinder, setOrgGroupPermissionPersistence, setOrgGroupRolePersistence, setOrgLaborLocalService, setOrgLaborPersistence, setOrgLaborService, setPasswordPolicyFinder, setPasswordPolicyLocalService, setPasswordPolicyPersistence, setPasswordPolicyRelLocalService, setPasswordPolicyRelPersistence, setPasswordPolicyService, setPasswordTrackerLocalService, setPasswordTrackerPersistence, setPermissionFinder, setPermissionLocalService, setPermissionPersistence, setPermissionService, setPhoneLocalService, setPhonePersistence, setPhoneService, setPluginSettingLocalService, setPluginSettingPersistence, setPluginSettingService, setPortalLocalService, setPortalPreferencesLocalService, setPortalPreferencesPersistence, setPortalService, setPortletItemLocalService, setPortletItemPersistence, setPortletLocalService, setPortletPersistence, setPortletPreferencesFinder, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setPortletPreferencesService, setPortletService, setQuartzLocalService, setRatingsStatsFinder, setRatingsStatsLocalService, setRatingsStatsPersistence, setRegionPersistence, setRegionService, setReleaseLocalService, setReleasePersistence, setRepositoryEntryLocalService, setRepositoryEntryPersistence, setRepositoryLocalService, setRepositoryPersistence, setRepositoryService, setResourceActionLocalService, setResourceActionPersistence, setResourceBlockFinder, setResourceBlockLocalService, setResourceBlockPermissionLocalService, setResourceBlockPermissionPersistence, setResourceBlockPersistence, setResourceBlockService, setResourceCodeLocalService, setResourceCodePersistence, setResourceFinder, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setResourcePermissionService, setResourcePersistence, setResourceService, setResourceTypePermissionFinder, setResourceTypePermissionLocalService, setResourceTypePermissionPersistence, setRoleFinder, setRoleLocalService, setRolePersistence, setRoleService, setServiceComponentLocalService, setServiceComponentPersistence, setShardLocalService, setShardPersistence, setSubscriptionLocalService, setSubscriptionPersistence, setTeamFinder, setTeamLocalService, setTeamPersistence, setTeamService, setThemeLocalService, setThemeService, setTicketLocalService, setTicketPersistence, setUserFinder, setUserGroupFinder, setUserGroupGroupRoleLocalService, setUserGroupGroupRolePersistence, setUserGroupGroupRoleService, setUserGroupLocalService, setUserGroupPersistence, setUserGroupRoleFinder, setUserGroupRoleLocalService, setUserGroupRolePersistence, setUserGroupRoleService, setUserGroupService, setUserIdMapperLocalService, setUserIdMapperPersistence, setUserLocalService, setUserNotificationEventLocalService, setUserNotificationEventPersistence, setUserPersistence, setUserService, setUserTrackerLocalService, setUserTrackerPathLocalService, setUserTrackerPathPersistence, setUserTrackerPersistence, setVirtualHostLocalService, setVirtualHostPersistence, setWebDAVPropsLocalService, setWebDAVPropsPersistence, setWebsiteLocalService, setWebsitePersistence, setWebsiteService, setWorkflowDefinitionLinkLocalService, setWorkflowDefinitionLinkPersistence, setWorkflowInstanceLinkLocalService, setWorkflowInstanceLinkPersistence, updateLayout, updateLayout
 
Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl
getClassLoader
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

layoutLocalServiceHelper

@BeanReference(type=LayoutLocalServiceHelper.class)
protected LayoutLocalServiceHelper layoutLocalServiceHelper
Constructor Detail

LayoutLocalServiceImpl

public LayoutLocalServiceImpl()
Method Detail

getCounterName

public static String getCounterName(long groupId,
                                    boolean privateLayout)
Returns the object counter's name.

Parameters:
groupId - the primary key of the group
privateLayout - whether layout is private to the group
Returns:
the object counter's name

addLayout

public Layout addLayout(long userId,
                        long groupId,
                        boolean privateLayout,
                        long parentLayoutId,
                        Map<Locale,String> nameMap,
                        Map<Locale,String> titleMap,
                        Map<Locale,String> descriptionMap,
                        Map<Locale,String> keywordsMap,
                        Map<Locale,String> robotsMap,
                        String type,
                        boolean hidden,
                        String friendlyURL,
                        ServiceContext serviceContext)
                 throws PortalException,
                        SystemException
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.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parentLayoutId - the primary key of the parent layout (optionally LayoutConstants.DEFAULT_PARENT_LAYOUT_ID)
nameMap - the layout's locales and localized names
titleMap - 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.
hidden - whether the layout is hidden
friendlyURL - the layout's friendly URL (optionally PropsValues.DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL or PropsValues.DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL). The default values can be overridden in portal-ext.properties by specifying new values for the corresponding properties defined in PropsValues. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).
serviceContext - the service context. Must set the universally unique identifier (UUID) for the layout. Can set the creation date, modification date and the expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named 'layoutUpdateable' can be set to specify whether site administrators can modify this page within their site. For layouts that are created from a layout prototype, attributes named 'layoutPrototypeUuid' and 'layoutPrototypeLinkedEnabled' can be specified to provide the unique identifier of the source prototype and a boolean to determined whether a link to it should be enabled to activate propagation of changes made to the linked page in the prototype.
Returns:
the layout
Throws:
PortalException - if a group or user with the primary key could not be found, or if layout values were invalid
SystemException - if a system exception occurred

addLayout

public Layout addLayout(long userId,
                        long groupId,
                        boolean privateLayout,
                        long parentLayoutId,
                        String name,
                        String title,
                        String description,
                        String type,
                        boolean hidden,
                        String friendlyURL,
                        ServiceContext serviceContext)
                 throws PortalException,
                        SystemException
Adds a layout.

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.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parentLayoutId - the primary key of the parent layout (optionally LayoutConstants.DEFAULT_PARENT_LAYOUT_ID). The possible values can be found in LayoutConstants.
name - the layout's name (optionally PropsValues.DEFAULT_USER_PRIVATE_LAYOUT_NAME or PropsValues.DEFAULT_USER_PUBLIC_LAYOUT_NAME). The default values can be overridden in portal-ext.properties by specifying new values for the corresponding properties defined in PropsValues
title - the layout's title
description - the layout's description
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 friendly URL of the layout (optionally PropsValues.DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL or PropsValues.DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL). The default values can be overridden in portal-ext.properties by specifying new values for the corresponding properties defined in PropsValues. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).
serviceContext - the service context. Must set the universally unique identifier (UUID) for the layout. Can set the creation date and modification date for the layout. For layouts that belong to a layout set prototype, an attribute named 'layoutUpdateable' can be set to specify whether site administrators can modify this page within their site.
Returns:
the layout
Throws:
PortalException - if a group or user with the primary key could not be found
SystemException - if a system exception occurred

deleteLayout

public void deleteLayout(Layout layout,
                         boolean updateLayoutSet,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Deletes the layout, its child layouts, and its associated resources.

Parameters:
layout - the layout
updateLayoutSet - whether the layout set's page counter needs to be updated
serviceContext - the service context
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

deleteLayout

public void deleteLayout(long groupId,
                         boolean privateLayout,
                         long layoutId,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
serviceContext - the service context
Throws:
PortalException - if a matching layout could not be found , or if some other portal exception occurred
SystemException - if a system exception occurred

deleteLayout

public void deleteLayout(long plid,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.

Parameters:
plid - the primary key of the layout
serviceContext - the service context
Throws:
PortalException - if a layout with the primary key could not be found , or if some other portal exception occurred
SystemException - if a system exception occurred

deleteLayouts

public void deleteLayouts(long groupId,
                          boolean privateLayout,
                          ServiceContext serviceContext)
                   throws PortalException,
                          SystemException
Deletes the group's private or non-private layouts, also deleting the layouts' child layouts, and associated resources.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
serviceContext - the service context
Throws:
PortalException - if a group with the primary key could not be found or if a layout set for the group and privacy could not be found
SystemException - if a system exception occurred

exportLayouts

public byte[] exportLayouts(long groupId,
                            boolean privateLayout,
                            long[] layoutIds,
                            Map<String,String[]> parameterMap,
                            Date startDate,
                            Date endDate)
                     throws PortalException,
                            SystemException
Exports layouts with the primary keys and criteria as a byte array.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutIds - the primary keys of the layouts to be exported
parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
startDate - the export's start date
endDate - the export's end date
Returns:
the layouts as a byte array
Throws:
PortalException - if a group or any layout with the primary key could not be found, or if some other portal exception occurred
SystemException - if a system exception occurred

exportLayouts

public byte[] exportLayouts(long groupId,
                            boolean privateLayout,
                            Map<String,String[]> parameterMap,
                            Date startDate,
                            Date endDate)
                     throws PortalException,
                            SystemException
Exports all layouts that match the criteria as a byte array.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
startDate - the export's start date
endDate - the export's end date
Returns:
the layout as a byte array
Throws:
PortalException - if a group with the primary key could not be found or if some other portal exception occurred
SystemException - if a system exception occurred

exportLayoutsAsFile

public File exportLayoutsAsFile(long groupId,
                                boolean privateLayout,
                                long[] layoutIds,
                                Map<String,String[]> parameterMap,
                                Date startDate,
                                Date endDate)
                         throws PortalException,
                                SystemException
Exports the layouts that match the primary keys and criteria as a file.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutIds - the primary keys of the layouts to be exported (optionally null)
parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
startDate - the export's start date
endDate - the export's end date
Returns:
the layouts as a File
Throws:
PortalException - if a group or any layout with the primary key could not be found, or if some other portal exception occurred
SystemException - if a system exception occurred

exportPortletInfo

public byte[] exportPortletInfo(long plid,
                                long groupId,
                                String portletId,
                                Map<String,String[]> parameterMap,
                                Date startDate,
                                Date endDate)
                         throws PortalException,
                                SystemException
Exports the portlet information (categories, permissions, ... etc.) as a byte array.

Parameters:
plid - the primary key of the layout
groupId - the primary key of the group
portletId - the primary key of the portlet
parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
startDate - the export's start date
endDate - the export's end date
Returns:
the portlet information as a byte array
Throws:
PortalException - if a group or portlet with the primary key could not be found, or if some other portal exception occurred
SystemException - if a system exception occurred

exportPortletInfoAsFile

public File exportPortletInfoAsFile(long plid,
                                    long groupId,
                                    String portletId,
                                    Map<String,String[]> parameterMap,
                                    Date startDate,
                                    Date endDate)
                             throws PortalException,
                                    SystemException
Exports the portlet information (categories, permissions, ... etc.) as a file.

Parameters:
plid - the primary key of the layout
groupId - the primary key of the group
portletId - the primary key of the portlet
parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
startDate - the export's start date
endDate - the export's end date
Returns:
the portlet information as a file
Throws:
PortalException - if a group or portlet with the primary key could not be found, or if some other portal exception occurred
SystemException - if a system exception occurred

fetchFirstLayout

public Layout fetchFirstLayout(long groupId,
                               boolean privateLayout,
                               long parentLayoutId)
                        throws SystemException
Throws:
SystemException

fetchLayoutByUuidAndGroupId

public Layout fetchLayoutByUuidAndGroupId(String uuid,
                                          long groupId,
                                          boolean privateLayout)
                                   throws SystemException
Parameters:
uuid - the universally unique identifier of the scope layout
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
Returns:
the layout, or null if a matching layout could not be found
Throws:
SystemException - if a system exception occurred

getDefaultPlid

public long getDefaultPlid(long groupId)
                    throws SystemException
Returns the primary key of the default layout for the group

Parameters:
groupId - the primary key of the group
Returns:
the primary key of the default layout for the group (optionally LayoutConstants.DEFAULT_PLID)
Throws:
SystemException - if a system exception occurred

getDefaultPlid

public long getDefaultPlid(long groupId,
                           boolean privateLayout)
                    throws SystemException
Returns primary key of the matching default layout for the group

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
Throws:
SystemException - if a system exception occurred

getDefaultPlid

public long getDefaultPlid(long groupId,
                           boolean privateLayout,
                           String portletId)
                    throws PortalException,
                           SystemException
Returns primary key of the default portlet layout for the group

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
portletId - the primary key of the portlet
Returns:
the primary key of the default portlet layout for the group; LayoutConstants.DEFAULT_PLID otherwise
Throws:
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred

getFriendlyURLLayout

public Layout getFriendlyURLLayout(long groupId,
                                   boolean privateLayout,
                                   String friendlyURL)
                            throws PortalException,
                                   SystemException
Returns the layout for the friendly URL

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
friendlyURL - the friendly URL of the layout
Returns:
the layout for the friendly URL
Throws:
PortalException - if the friendly URL is null or a matching layout could not be found
SystemException - if a system exception occurred

getLayout

public Layout getLayout(long groupId,
                        boolean privateLayout,
                        long layoutId)
                 throws PortalException,
                        SystemException
Returns the layout matching the primary key, group, and privacy; throws a NoSuchLayoutException otherwise.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
Returns:
the matching layout
Throws:
PortalException - if a matching layout could not be found
SystemException - if a system exception occurred

getLayoutByIconImageId

public Layout getLayoutByIconImageId(long iconImageId)
                              throws PortalException,
                                     SystemException
Returns the layout for the icon image; throws a NoSuchLayoutException otherwise.

Parameters:
iconImageId - the primary key of the icon image
Returns:
Returns the layout for the icon image
Throws:
PortalException - if an icon image with the primary key could not be found
SystemException - if a system exception occurred

getLayouts

public List<Layout> getLayouts(long groupId,
                               boolean privateLayout)
                        throws SystemException
Returns all the layouts belonging to the group.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
Returns:
the matching layouts, or null if no matches were found
Throws:
SystemException - if a system exception occurred

getLayouts

public List<Layout> getLayouts(long groupId,
                               boolean privateLayout,
                               long parentLayoutId)
                        throws SystemException
Returns all the layouts belonging to the group that are children of the parent layout.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parentLayoutId - the primary key of the parent layout
Returns:
the matching layouts, or null if no matches were found
Throws:
SystemException - if a system exception occurred

getLayouts

public List<Layout> getLayouts(long groupId,
                               boolean privateLayout,
                               long parentLayoutId,
                               boolean incomplete,
                               int start,
                               int end)
                        throws SystemException
Returns a range of all the layouts belonging to the group that are children of the parent layout.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parentLayoutId - the primary key of the parent layout
incomplete - whether the layout is incomplete
start - the lower bound of the range of layouts
end - the upper bound of the range of layouts (not inclusive)
Returns:
the matching layouts, or null if no matches were found
Throws:
SystemException - if a system exception occurred

getLayouts

public List<Layout> getLayouts(long groupId,
                               boolean privateLayout,
                               long[] layoutIds)
                        throws PortalException,
                               SystemException
Returns all the layouts that match the layout IDs and belong to the group.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutIds - the primary keys of the layouts
Returns:
the matching layouts, or null if no matches were found
Throws:
PortalException - if a group or layout with the primary key could not be found
SystemException - if a system exception occurred

getLayouts

public List<Layout> getLayouts(long groupId,
                               boolean privateLayout,
                               String type)
                        throws SystemException
Returns all the layouts that match the type and belong to the group.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
type - the type of the layouts (optionally LayoutConstants.TYPE_PORTLET)
Returns:
the matching layouts, or null if no matches were found
Throws:
SystemException - if a system exception occurred

getLayouts

public LayoutReference[] getLayouts(long companyId,
                                    String portletId,
                                    String preferencesKey,
                                    String preferencesValue)
                             throws SystemException
Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences.

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
Throws:
SystemException - if a system exception occurred

getLayoutsByLayoutPrototypeUuidCount

public int getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid)
                                         throws SystemException
Throws:
SystemException

getLayoutsCount

public int getLayoutsCount(Group group,
                           boolean privateLayout)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getLayoutsCount

public int getLayoutsCount(Group group,
                           boolean privateLayout,
                           boolean includeUserGroups)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getLayoutsCount

public int getLayoutsCount(User user,
                           boolean privateLayout)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getLayoutsCount

public int getLayoutsCount(User user,
                           boolean privateLayout,
                           boolean includeUserGroups)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getNextLayoutId

public long getNextLayoutId(long groupId,
                            boolean privateLayout)
                     throws SystemException
Returns the primary key to use for the next layout.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
Returns:
the primary key to use for the next layout
Throws:
SystemException - if a system exception occurred

getNullFriendlyURLLayouts

public List<Layout> getNullFriendlyURLLayouts()
                                       throws SystemException
Returns all the layouts whose friendly URLs are null

Returns:
all the layouts whose friendly URLs are null
Throws:
SystemException - if a system exception occurred

getScopeGroupLayouts

public List<Layout> getScopeGroupLayouts(long groupId,
                                         boolean privateLayout)
                                  throws SystemException
Returns all the layouts within scope of the group

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
Returns:
the layouts within scope of the group
Throws:
SystemException - if a system exception occurred

hasLayouts

public boolean hasLayouts(Group group,
                          boolean privateLayout)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

hasLayouts

public boolean hasLayouts(Group group,
                          boolean privateLayout,
                          boolean includeUserGroups)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

hasLayouts

public boolean hasLayouts(long groupId,
                          boolean privateLayout,
                          long parentLayoutId)
                   throws SystemException
Returns true if the group has any layouts; false otherwise.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parentLayoutId - the primary key of the parent layout
Returns:
true if the group has any layouts; false otherwise
Throws:
SystemException - if a system exception occurred

hasLayouts

public boolean hasLayouts(User user,
                          boolean privateLayout)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

hasLayouts

public boolean hasLayouts(User user,
                          boolean privateLayout,
                          boolean includeUserGroups)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

hasLayoutSetPrototypeLayout

public boolean hasLayoutSetPrototypeLayout(long layoutSetPrototypeId,
                                           String layoutUuid)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

hasLayoutSetPrototypeLayout

public boolean hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid,
                                           String layoutUuid)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

importLayouts

public void importLayouts(long userId,
                          long groupId,
                          boolean privateLayout,
                          Map<String,String[]> parameterMap,
                          byte[] bytes)
                   throws PortalException,
                          SystemException
Imports the layouts from the byte array.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
bytes - the byte array with the data
Throws:
PortalException - if a group or user with the primary key could not be found, or if some other portal exception occurred
SystemException - if a system exception occurred
See Also:
LayoutImporter

importLayouts

public void importLayouts(long userId,
                          long groupId,
                          boolean privateLayout,
                          Map<String,String[]> parameterMap,
                          File file)
                   throws PortalException,
                          SystemException
Imports the layouts from the file.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
file - the LAR file with the data
Throws:
PortalException - if a group or user with the primary key could not be found, or if some other portal exception occurred
SystemException - if a system exception occurred
See Also:
LayoutImporter

importLayouts

public void importLayouts(long userId,
                          long groupId,
                          boolean privateLayout,
                          Map<String,String[]> parameterMap,
                          InputStream is)
                   throws PortalException,
                          SystemException
Imports the layouts from the input stream.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
is - the input stream
Throws:
PortalException - if a group or user with the primary key could not be found, or if some other portal exception occurred
SystemException - if a system exception occurred
See Also:
LayoutImporter

importPortletInfo

public void importPortletInfo(long userId,
                              long plid,
                              long groupId,
                              String portletId,
                              Map<String,String[]> parameterMap,
                              File file)
                       throws PortalException,
                              SystemException
Imports the portlet information (categories, permissions, ... etc.) from the file.

Parameters:
userId - the primary key of the user
plid - the primary key of the target layout
groupId - the primary key of the target group
portletId - the primary key of the portlet
parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
file - the LAR file with the data
Throws:
PortalException - if a group, layout, portlet or user with the primary key could not be found
SystemException - if a system exception occurred

importPortletInfo

public void importPortletInfo(long userId,
                              long plid,
                              long groupId,
                              String portletId,
                              Map<String,String[]> parameterMap,
                              InputStream is)
                       throws PortalException,
                              SystemException
Imports the portlet information (categories, permissions, ... etc.) from the input stream.

Parameters:
userId - the primary key of the user
plid - the primary key of the layout
groupId - the primary key of the group
portletId - the primary key of the portlet
parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
is - the input stream
Throws:
PortalException - if a group, portlet, layout or user with the primary key could not be found
SystemException - if a system exception occurred

setLayouts

public void setLayouts(long groupId,
                       boolean privateLayout,
                       long parentLayoutId,
                       long[] layoutIds,
                       ServiceContext serviceContext)
                throws PortalException,
                       SystemException
Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parentLayoutId - the primary key of the parent layout
layoutIds - the primary keys of the layouts
serviceContext - the service context
Throws:
PortalException - if a group or layout with the primary key could not be found, if no layouts were specified, if the first layout was not page-able, if the first layout was hidden, or if some other portal exception occurred
SystemException - if a system exception occurred

updateFriendlyURL

public Layout updateFriendlyURL(long plid,
                                String friendlyURL)
                         throws PortalException,
                                SystemException
Updates the friendly URL of the layout.

Parameters:
plid - the primary key of the layout
friendlyURL - the friendly URL to be assigned
Returns:
the updated layout
Throws:
PortalException - if a group or layout with the primary key could not be found
SystemException - if a system exception occurred

updateLayout

public Layout updateLayout(long groupId,
                           boolean privateLayout,
                           long layoutId,
                           long parentLayoutId,
                           Map<Locale,String> nameMap,
                           Map<Locale,String> titleMap,
                           Map<Locale,String> descriptionMap,
                           Map<Locale,String> keywordsMap,
                           Map<Locale,String> robotsMap,
                           String type,
                           boolean hidden,
                           String friendlyURL,
                           Boolean iconImage,
                           byte[] iconBytes,
                           ServiceContext serviceContext)
                    throws PortalException,
                           SystemException
Updates the layout.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
parentLayoutId - the primary key of the layout's new parent layout
nameMap - the locales and localized names to merge (optionally null)
titleMap - the locales and localized titles to merge (optionally null)
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
friendlyURL - the layout's new friendly URL (optionally PropsValues.DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL or PropsValues.DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL). The default values can be overridden in portal-ext.properties by specifying new values for the corresponding properties defined in PropsValues. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).
iconImage - whether the icon image will be updated
iconBytes - the byte array of the layout's new icon image
serviceContext - the service context. Can set the modification date and expando bridge attributes for the layout. For layouts that are linked to a layout prototype, attributes named 'layoutPrototypeUuid' and 'layoutPrototypeLinkedEnabled' can be specified to provide the unique identifier of the source prototype and a boolean to determined whether a link to it should be enabled to activate propagation of changes made to the linked page in the prototype.
Returns:
the updated layout
Throws:
PortalException - if a group or layout with the primary key could not be found, if a unique friendly URL could not be generated, if a valid parent layout ID to use could not be found, or if the layout parameters were invalid
SystemException - if a system exception occurred

updateLayout

public Layout updateLayout(long groupId,
                           boolean privateLayout,
                           long layoutId,
                           String typeSettings)
                    throws PortalException,
                           SystemException
Updates the layout replacing its type settings.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
typeSettings - the settings to load the unicode properties object. See #fastLoad(String).
Returns:
the updated layout
Throws:
PortalException - if a matching layout could not be found
SystemException - if a system exception occurred

updateLookAndFeel

public Layout updateLookAndFeel(long groupId,
                                boolean privateLayout,
                                long layoutId,
                                String themeId,
                                String colorSchemeId,
                                String css,
                                boolean wapTheme)
                         throws PortalException,
                                SystemException
Updates the look and feel of the layout.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key 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
wapTheme - whether the theme is for WAP browsers
Returns:
the updated layout
Throws:
PortalException - if a matching layout could not be found
SystemException - if a system exception occurred

updateName

public Layout updateName(Layout layout,
                         String name,
                         String languageId)
                  throws PortalException,
                         SystemException
Updates the name of the layout.

Parameters:
layout - the layout to be updated
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 the new name was null
SystemException - if a system exception occurred

updateName

public Layout updateName(long groupId,
                         boolean privateLayout,
                         long layoutId,
                         String name,
                         String languageId)
                  throws PortalException,
                         SystemException
Updates the name of the layout matching the group, layout ID, and privacy.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key 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 matching layout could not be found or if the new name was null
SystemException - if a system exception occurred

updateName

public Layout updateName(long plid,
                         String name,
                         String languageId)
                  throws PortalException,
                         SystemException
Updates the name of the layout matching the primary key.

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 layout with the primary key could not be found or if the name was null
SystemException - if a system exception occurred

updateParentLayoutId

public Layout updateParentLayoutId(long groupId,
                                   boolean privateLayout,
                                   long layoutId,
                                   long parentLayoutId)
                            throws PortalException,
                                   SystemException
Updates the parent layout ID of the layout matching the group, layout ID, and privacy.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
parentLayoutId - the primary key to be assigned to the parent layout
Returns:
the matching layout
Throws:
PortalException - if a valid parent layout ID to use could not be found or if a matching layout could not be found
SystemException - if a system exception occurred

updateParentLayoutId

public Layout updateParentLayoutId(long plid,
                                   long parentPlid)
                            throws PortalException,
                                   SystemException
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.

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 layout with the primary key could not be found or if a valid parent layout ID to use could not be found
SystemException - if a system exception occurred

updatePriorities

public void updatePriorities(long groupId,
                             boolean privateLayout)
                      throws PortalException,
                             SystemException
Updates the priorities of the layouts.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
Throws:
PortalException - if a matching layout could not be found
SystemException - if a system exception occurred

updatePriority

public Layout updatePriority(Layout layout,
                             int priority)
                      throws SystemException
Updates the priority of the layout.

Parameters:
layout - the layout to be updated
priority - the layout's new priority
Returns:
the updated layout
Throws:
SystemException - if a system exception occurred

updatePriority

public Layout updatePriority(long groupId,
                             boolean privateLayout,
                             long layoutId,
                             int priority)
                      throws PortalException,
                             SystemException
Updates the priority of the layout matching the group, layout ID, and privacy.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
priority - the layout's new priority
Returns:
the updated layout
Throws:
PortalException - if a matching layout could not be found
SystemException - if a system exception occurred

updatePriority

public Layout updatePriority(long plid,
                             int priority)
                      throws PortalException,
                             SystemException
Updates the priority of the layout matching the primary key.

Parameters:
plid - the primary key of the layout
priority - the layout's new priority
Returns:
the updated layout
Throws:
PortalException - if a layout with the primary key could not be found
SystemException - if a system exception occurred

updateScopedPortletNames

public void updateScopedPortletNames(long groupId,
                                     boolean privateLayout,
                                     long layoutId,
                                     Map<Locale,String> nameMap,
                                     List<Locale> nameMapModifiedLocales)
                              throws PortalException,
                                     SystemException
Deprecated. As of 6.2.0, with no direct replacement

Throws:
PortalException
SystemException

updateScopedPortletNames

public void updateScopedPortletNames(long groupId,
                                     boolean privateLayout,
                                     long layoutId,
                                     String name,
                                     String languageId)
                              throws PortalException,
                                     SystemException
Deprecated. As of 6.2.0, with no direct replacement

Updates the names of the portlets within scope of the group, the scope of the layout's universally unique identifier, and the privacy.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout whose universally unique identifier to match
name - the new name for the portlets
languageId - the primary key of the language
Throws:
PortalException - if a matching layout could not be found
SystemException - if a system exception occurred
See Also:
EditScopeAction

validateTypeSettingsProperties

protected void validateTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
                                       throws PortalException
Throws:
PortalException

Liferay 6.1.2-ce-ga3