com.liferay.portal.service
Class LayoutLocalServiceWrapper

java.lang.Object
  com.liferay.portal.service.LayoutLocalServiceWrapper

All Implemented Interfaces:

BaseLocalService, LayoutLocalService, PersistedModelLocalService, ServiceWrapper<LayoutLocalService>

public class LayoutLocalServiceWrapper
extends Object
implements LayoutLocalService, ServiceWrapper<LayoutLocalService>

This class is a wrapper for LayoutLocalService.

See Also:

LayoutLocalService

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

LayoutLocalServiceWrapper(LayoutLocalService layoutLocalService)

Method Summary

Layout	addLayout(Layout layout) Adds the layout to the database.
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.
Layout	createLayout(long plid) Creates a new layout with the primary key.
Layout	deleteLayout(Layout layout) Deletes the layout from the database.
void	deleteLayout(Layout layout, boolean updateLayoutSet, ServiceContext serviceContext) Deletes the layout, its child layouts, and its associated resources.
Layout	deleteLayout(long plid) Deletes the layout with the primary key from the database.
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.
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
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	fetchLayout(long plid)
Layout	fetchLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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 plid) Returns the layout with the primary key.
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.
Layout	getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)
List<Layout>	getLayouts(int start, int end) Returns a range of all the layouts.
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() Returns the number of layouts.
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
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<Layout>	getScopeGroupLayouts(long groupId, boolean privateLayout) Returns all the layouts within scope of the group
LayoutLocalService	getWrappedLayoutLocalService() Deprecated. Renamed to getWrappedService()
LayoutLocalService	getWrappedService()
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	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
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.
void	setWrappedLayoutLocalService(LayoutLocalService layoutLocalService) Deprecated. Renamed to setWrappedService(com.liferay.portal.service.LayoutLocalService)
void	setWrappedService(LayoutLocalService layoutLocalService)
Layout	updateFriendlyURL(long plid, String friendlyURL) Updates the friendly URL of the layout.
Layout	updateLayout(Layout layout) Updates the layout in the database or adds it if it does not yet exist.
Layout	updateLayout(Layout layout, boolean merge) Updates the layout in the database or adds it if it does not yet exist.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutLocalServiceWrapper

public LayoutLocalServiceWrapper(LayoutLocalService layoutLocalService)

Method Detail

addLayout

public Layout addLayout(Layout layout)
                 throws SystemException

Adds the layout to the database. Also notifies the appropriate model listeners.

Specified by:

addLayout in interface LayoutLocalService

Parameters:

layout - the layout

Returns:

the layout that was added

Throws:

SystemException - if a system exception occurred

createLayout

public Layout createLayout(long plid)

Creates a new layout with the primary key. Does not add the layout to the database.

Specified by:

createLayout in interface LayoutLocalService

Parameters:

plid - the primary key for the new layout

Returns:

the new layout

deleteLayout

public Layout deleteLayout(long plid)
                    throws PortalException,
                           SystemException

Deletes the layout with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:

deleteLayout in interface LayoutLocalService

Parameters:

plid - the primary key of the layout

Returns:

the layout that was removed

Throws:

PortalException - if a layout with the primary key could not be found

SystemException - if a system exception occurred

deleteLayout

public Layout deleteLayout(Layout layout)
                    throws SystemException

Deletes the layout from the database. Also notifies the appropriate model listeners.

Specified by:

deleteLayout in interface LayoutLocalService

Parameters:

layout - the layout

Returns:

the layout that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface LayoutLocalService

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Specified by:

dynamicQuery in interface LayoutLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)
                  throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

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.

Specified by:

dynamicQuery in interface LayoutLocalService

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator orderByComparator)
                  throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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.

Specified by:

dynamicQuery in interface LayoutLocalService

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Specified by:

dynamicQueryCount in interface LayoutLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchLayout

public Layout fetchLayout(long plid)
                   throws SystemException

Specified by:

fetchLayout in interface LayoutLocalService

Throws:

SystemException

getLayout

public Layout getLayout(long plid)
                 throws PortalException,
                        SystemException

Returns the layout with the primary key.

Specified by:

getLayout in interface LayoutLocalService

Parameters:

plid - the primary key of the layout

Returns:

the layout

Throws:

PortalException - if a layout with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface LayoutLocalService

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getLayoutByUuidAndGroupId

public Layout getLayoutByUuidAndGroupId(String uuid,
                                        long groupId,
                                        boolean privateLayout)
                                 throws PortalException,
                                        SystemException

Specified by:

getLayoutByUuidAndGroupId in interface LayoutLocalService

Parameters:

uuid - the UUID of layout

groupId - the group id of the layout

privateLayout - whether the layout is private to the group

Returns:

the layout

Throws:

PortalException - if a layout with the UUID in the group and privateLayout could not be found

SystemException - if a system exception occurred

getLayouts

public List<Layout> getLayouts(int start,
                               int end)
                        throws SystemException

Returns a range of all the layouts.

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.

Specified by:

getLayouts in interface LayoutLocalService

Parameters:

start - the lower bound of the range of layouts

end - the upper bound of the range of layouts (not inclusive)

Returns:

the range of layouts

Throws:

SystemException - if a system exception occurred

getLayoutsCount

public int getLayoutsCount()
                    throws SystemException

Returns the number of layouts.

Specified by:

getLayoutsCount in interface LayoutLocalService

Returns:

the number of layouts

Throws:

SystemException - if a system exception occurred

updateLayout

public Layout updateLayout(Layout layout)
                    throws SystemException

Updates the layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:

updateLayout in interface LayoutLocalService

Parameters:

layout - the layout

Returns:

the layout that was updated

Throws:

SystemException - if a system exception occurred

updateLayout

public Layout updateLayout(Layout layout,
                           boolean merge)
                    throws SystemException

Updates the layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:

updateLayout in interface LayoutLocalService

Parameters:

layout - the layout

merge - whether to merge the layout with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the layout that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Specified by:

getBeanIdentifier in interface LayoutLocalService

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Specified by:

setBeanIdentifier in interface LayoutLocalService

Parameters:

beanIdentifier - the Spring bean ID for this bean

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.

Specified by:

addLayout in interface LayoutLocalService

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.

Specified by:

addLayout in interface LayoutLocalService

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.

Specified by:

deleteLayout in interface LayoutLocalService

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.

Specified by:

deleteLayout in interface LayoutLocalService

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.

Specified by:

deleteLayout in interface LayoutLocalService

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.

Specified by:

deleteLayouts in interface LayoutLocalService

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.

Specified by:

exportLayouts in interface LayoutLocalService

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.

Specified by:

exportLayouts in interface LayoutLocalService

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.

Specified by:

exportLayoutsAsFile in interface LayoutLocalService

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.

Specified by:

exportPortletInfo in interface LayoutLocalService

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.

Specified by:

exportPortletInfoAsFile in interface LayoutLocalService

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

Specified by:

fetchFirstLayout in interface LayoutLocalService

Throws:

SystemException

fetchLayoutByUuidAndGroupId

public Layout fetchLayoutByUuidAndGroupId(String uuid,
                                          long groupId,
                                          boolean privateLayout)
                                   throws SystemException

Specified by:

fetchLayoutByUuidAndGroupId in interface LayoutLocalService

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

Specified by:

getDefaultPlid in interface LayoutLocalService

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

Specified by:

getDefaultPlid in interface LayoutLocalService

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

Specified by:

getDefaultPlid in interface LayoutLocalService

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

Specified by:

getFriendlyURLLayout in interface LayoutLocalService

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.

Specified by:

getLayout in interface LayoutLocalService

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.

Specified by:

getLayoutByIconImageId in interface LayoutLocalService

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.

Specified by:

getLayouts in interface LayoutLocalService

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.

Specified by:

getLayouts in interface LayoutLocalService

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.

Specified by:

getLayouts in interface LayoutLocalService

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.

Specified by:

getLayouts in interface LayoutLocalService

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.

Specified by:

getLayouts in interface LayoutLocalService

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.

Specified by:

getLayouts in interface LayoutLocalService

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

Specified by:

getLayoutsByLayoutPrototypeUuidCount in interface LayoutLocalService

Throws:

SystemException

getLayoutsCount

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

Specified by:

getLayoutsCount in interface LayoutLocalService

Throws:

PortalException

SystemException

getLayoutsCount

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

Specified by:

getLayoutsCount in interface LayoutLocalService

Throws:

PortalException

SystemException

getLayoutsCount

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

Specified by:

getLayoutsCount in interface LayoutLocalService

Throws:

PortalException

SystemException

getLayoutsCount

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

Specified by:

getLayoutsCount in interface LayoutLocalService

Throws:

PortalException

SystemException

getNextLayoutId

public long getNextLayoutId(long groupId,
                            boolean privateLayout)
                     throws SystemException

Returns the primary key to use for the next layout.

Specified by:

getNextLayoutId in interface LayoutLocalService

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

Specified by:

getNullFriendlyURLLayouts in interface LayoutLocalService

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

Specified by:

getScopeGroupLayouts in interface LayoutLocalService

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

Specified by:

hasLayouts in interface LayoutLocalService

Throws:

PortalException

SystemException

hasLayouts

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

Specified by:

hasLayouts in interface LayoutLocalService

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.

Specified by:

hasLayouts in interface LayoutLocalService

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

Specified by:

hasLayouts in interface LayoutLocalService

Throws:

PortalException

SystemException

hasLayouts

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

Specified by:

hasLayouts in interface LayoutLocalService

Throws:

PortalException

SystemException

hasLayoutSetPrototypeLayout

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

Specified by:

hasLayoutSetPrototypeLayout in interface LayoutLocalService

Throws:

PortalException

SystemException

hasLayoutSetPrototypeLayout

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

Specified by:

hasLayoutSetPrototypeLayout in interface LayoutLocalService

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.

Specified by:

importLayouts in interface LayoutLocalService

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.

Specified by:

importLayouts in interface LayoutLocalService

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.

Specified by:

importLayouts in interface LayoutLocalService

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.

Specified by:

importPortletInfo in interface LayoutLocalService

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.

Specified by:

importPortletInfo in interface LayoutLocalService

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.

Specified by:

setLayouts in interface LayoutLocalService

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.

Specified by:

updateFriendlyURL in interface LayoutLocalService

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.

Specified by:

updateLayout in interface LayoutLocalService

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.

Specified by:

updateLayout in interface LayoutLocalService

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.

Specified by:

updateLookAndFeel in interface LayoutLocalService

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.

Specified by:

updateName in interface LayoutLocalService

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.

Specified by:

updateName in interface LayoutLocalService

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.

Specified by:

updateName in interface LayoutLocalService

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.

Specified by:

updateParentLayoutId in interface LayoutLocalService

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.

Specified by:

updateParentLayoutId in interface LayoutLocalService

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.

Specified by:

updatePriorities in interface LayoutLocalService

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.

Specified by:

updatePriority in interface LayoutLocalService

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.

Specified by:

updatePriority in interface LayoutLocalService

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.

Specified by:

updatePriority in interface LayoutLocalService

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

Specified by:

updateScopedPortletNames in interface LayoutLocalService

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.

Specified by:

updateScopedPortletNames in interface LayoutLocalService

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

getWrappedLayoutLocalService

public LayoutLocalService getWrappedLayoutLocalService()

Deprecated. Renamed to getWrappedService()

setWrappedLayoutLocalService

public void setWrappedLayoutLocalService(LayoutLocalService layoutLocalService)

Deprecated. Renamed to setWrappedService(com.liferay.portal.service.LayoutLocalService)

getWrappedService

public LayoutLocalService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<LayoutLocalService>

setWrappedService

public void setWrappedService(LayoutLocalService layoutLocalService)

Specified by:

setWrappedService in interface ServiceWrapper<LayoutLocalService>