LayoutLocalServiceUtil (Liferay 6.2-ce-ga5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.2-ce-ga5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service
Class LayoutLocalServiceUtil

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

@ProviderType public class LayoutLocalServiceUtil
extends Object
extends Object

Provides the local service utility for Layout. This utility wraps com.liferay.portal.service.impl.LayoutLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:: LayoutLocalService, LayoutLocalServiceBaseImpl, com.liferay.portal.service.impl.LayoutLocalServiceImpl

Constructor Summary
`LayoutLocalServiceUtil()`

Method Summary
`static Layout`	`addLayout(Layout layout)` Adds the layout to the database.
`static 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)` Deprecated. As of 6.2.0, replaced by `addLayout(long, long, boolean, long, Map, Map, Map, Map, Map, String, String, boolean, Map, ServiceContext)`
`static 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, String typeSettings, boolean hidden, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext)` Adds a layout with additional parameters.
`static 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 with single entry maps for name, title, and description to the default locale.
`static Layout`	`createLayout(long plid)` Creates a new layout with the primary key.
`static Layout`	`deleteLayout(Layout layout)` Deletes the layout from the database.
`static void`	`deleteLayout(Layout layout, boolean updateLayoutSet, ServiceContext serviceContext)` Deletes the layout, its child layouts, and its associated resources.
`static Layout`	`deleteLayout(long plid)` Deletes the layout with the primary key from the database.
`static 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.
`static void`	`deleteLayout(long plid, ServiceContext serviceContext)` Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.
`static 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.
`static DynamicQuery`	`dynamicQuery()`
`static List`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`static List`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end)` Performs a dynamic query on the database and returns a range of the matching rows.
`static 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.
`static long`	`dynamicQueryCount(DynamicQuery dynamicQuery)` Returns the number of rows that match the dynamic query.
`static long`	`dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)` Returns the number of rows that match the dynamic query.
`static 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.
`static 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.
`static 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.
`static long`	`exportLayoutsAsFileInBackground(long userId, String taskName, long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName)`
`static 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.
`static byte[]`	`exportPortletInfo(long companyId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)`
`static 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.
`static File`	`exportPortletInfoAsFile(long companyId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)`
`static long`	`exportPortletInfoAsFileInBackground(long userId, String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName)`
`static long`	`exportPortletInfoAsFileInBackground(long userId, String taskName, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName)`
`static Layout`	`fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId)`
`static Layout`	`fetchLayout(long plid)`
`static Layout`	`fetchLayout(long groupId, boolean privateLayout, long layoutId)`
`static Layout`	`fetchLayoutByFriendlyURL(long groupId, boolean privateLayout, String friendlyURL)`
`static Layout`	`fetchLayoutByUuidAndCompanyId(String uuid, long companyId)` Returns the layout with the matching UUID and company.
`static Layout`	`fetchLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)` Returns the layout matching the UUID, group, and privacy.
`static String`	`getBeanIdentifier()` Returns the Spring bean ID for this bean.
`static long`	`getDefaultPlid(long groupId)` Returns the primary key of the default layout for the group
`static long`	`getDefaultPlid(long groupId, boolean privateLayout)` Returns primary key of the matching default layout for the group
`static long`	`getDefaultPlid(long groupId, boolean privateLayout, String portletId)` Returns primary key of the default portlet layout for the group
`static Layout`	`getFriendlyURLLayout(long groupId, boolean privateLayout, String friendlyURL)` Returns the layout for the friendly URL
`static Layout`	`getLayout(long plid)` Returns the layout with the primary key.
`static Layout`	`getLayout(long groupId, boolean privateLayout, long layoutId)` Returns the layout matching the primary key, group, and privacy; throws a `NoSuchLayoutException` otherwise.
`static Layout`	`getLayoutByIconImageId(long iconImageId)` Returns the layout for the icon image; throws a `NoSuchLayoutException` otherwise.
`static Layout`	`getLayoutByUuidAndCompanyId(String uuid, long companyId)` Returns the layout with the matching UUID and company.
`static Layout`	`getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)` Returns the layout matching the UUID, group, and privacy.
`static List<Layout>`	`getLayouts(int start, int end)` Returns a range of all the layouts.
`static List<Layout>`	`getLayouts(long groupId, boolean privateLayout)` Returns all the layouts belonging to the group.
`static List<Layout>`	`getLayouts(long groupId, boolean privateLayout, long parentLayoutId)` Returns all the layouts belonging to the group that are children of the parent layout.
`static List<Layout>`	`getLayouts(long groupId, boolean privateLayout, long[] layoutIds)` Returns all the layouts that match the layout IDs and belong to the group.
`static 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.
`static List<Layout>`	`getLayouts(long groupId, boolean privateLayout, String type)` Returns all the layouts that match the type and belong to the group.
`static 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.
`static List<Layout>`	`getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid)`
`static int`	`getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid)`
`static int`	`getLayoutsCount()` Returns the number of layouts.
`static int`	`getLayoutsCount(Group group, boolean privateLayout)`
`static int`	`getLayoutsCount(Group group, boolean privateLayout, boolean includeUserGroups)`
`static int`	`getLayoutsCount(User user, boolean privateLayout)`
`static int`	`getLayoutsCount(User user, boolean privateLayout, boolean includeUserGroups)`
`static long`	`getNextLayoutId(long groupId, boolean privateLayout)` Returns the primary key to use for the next layout.
`static List<Layout>`	`getNoPermissionLayouts(long roleId)` Returns all the layouts without resource permissions
`static List<Layout>`	`getNullFriendlyURLLayouts()` Returns all the layouts whose friendly URLs are `null`
`static Layout`	`getParentLayout(Layout layout)`
`static PersistedModel`	`getPersistedModel(Serializable primaryKeyObj)`
`static List<Layout>`	`getScopeGroupLayouts(long groupId, boolean privateLayout)` Returns all the layouts within scope of the group
`static LayoutLocalService`	`getService()`
`static boolean`	`hasLayouts(Group group, boolean privateLayout)`
`static boolean`	`hasLayouts(Group group, boolean privateLayout, boolean includeUserGroups)`
`static boolean`	`hasLayouts(long groupId, boolean privateLayout, long parentLayoutId)` Returns `true` if the group has any layouts; `false` otherwise.
`static boolean`	`hasLayouts(User user, boolean privateLayout)`
`static boolean`	`hasLayouts(User user, boolean privateLayout, boolean includeUserGroups)`
`static boolean`	`hasLayoutSetPrototypeLayout(long layoutSetPrototypeId, String layoutUuid)`
`static boolean`	`hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid, long companyId, String layoutUuid)`
`static void`	`importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes)` Imports the layouts from the byte array.
`static void`	`importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)` Imports the layouts from the file.
`static void`	`importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is)` Imports the layouts from the input stream.
`static long`	`importLayoutsInBackground(long userId, String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)`
`static long`	`importLayoutsInBackground(long userId, String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is)`
`static 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.
`static 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.
`static void`	`importPortletInfo(long userId, String portletId, Map<String,String[]> parameterMap, File file)`
`static void`	`importPortletInfo(long userId, String portletId, Map<String,String[]> parameterMap, InputStream is)`
`static long`	`importPortletInfoInBackground(long userId, String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)`
`static long`	`importPortletInfoInBackground(long userId, String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is)`
`static long`	`importPortletInfoInBackground(long userId, String taskName, String portletId, Map<String,String[]> parameterMap, File file)`
`static long`	`importPortletInfoInBackground(long userId, String taskName, String portletId, Map<String,String[]> parameterMap, InputStream is)`
`static void`	`setBeanIdentifier(String beanIdentifier)` Sets the Spring bean ID for this bean.
`static 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`	`setService(LayoutLocalService service)` Deprecated. As of 6.2.0
`static Layout`	`updateFriendlyURL(long plid, String friendlyURL, String languageId)` Updates the friendly URL of the layout.
`static Layout`	`updateLayout(Layout layout)` Updates the layout in the database or adds it if it does not yet exist.
`static 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, Map<Locale,String> friendlyURLMap, Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext)` Updates the layout.
`static 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)` Deprecated. As of 6.2.0, replaced by `updateLayout(long, boolean, long, long, Map, Map, Map, Map, Map, String, boolean, Map, Boolean, byte[], ServiceContext)`
`static Layout`	`updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings)` Updates the layout replacing its type settings.
`static Layout`	`updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css, boolean wapTheme)` Updates the look and feel of the layout.
`static Layout`	`updateName(Layout layout, String name, String languageId)` Updates the name of the layout.
`static 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.
`static Layout`	`updateName(long plid, String name, String languageId)` Updates the name of the layout matching the primary key.
`static 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.
`static Layout`	`updateParentLayoutId(long plid, long parentPlid)` Updates the parent layout ID of the layout matching the primary key.
`static Layout`	`updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority)`
`static void`	`updatePriorities(long groupId, boolean privateLayout)` Updates the priorities of the layouts.
`static Layout`	`updatePriority(Layout layout, int priority)` Updates the priority of the layout.
`static Layout`	`updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)` Updates the priority of the layout matching the group, layout ID, and privacy.
`static Layout`	`updatePriority(long groupId, boolean privateLayout, long layoutId, long nextLayoutId, long previousLayoutId)` Updates the priority of the layout matching the group, layout ID, and privacy, setting the layout's priority based on the priorities of the next and previous layouts.
`static Layout`	`updatePriority(long plid, int priority)` Updates the priority of the layout matching the primary key.
`static 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
`static void`	`updateScopedPortletNames(long groupId, boolean privateLayout, long layoutId, String name, String languageId)` Deprecated. As of 6.2.0, with no direct replacement
`static MissingReferences`	`validateImportLayoutsFile(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)`
`static MissingReferences`	`validateImportLayoutsFile(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream inputStream)`
`static MissingReferences`	`validateImportPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)`
`static MissingReferences`	`validateImportPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream inputStream)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

LayoutLocalServiceUtil

public LayoutLocalServiceUtil()

Method Detail

addLayout

public static Layout addLayout(Layout layout)
                        throws SystemException

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

Parameters:: layout - the layout
Returns:: the layout that was added
Throws:: SystemException - if a system exception occurred

createLayout

public static Layout createLayout(long plid)

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

Parameters:: plid - the primary key for the new layout
Returns:: the new layout

deleteLayout

public static Layout deleteLayout(long plid)
                           throws PortalException,
                                  SystemException

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

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 static Layout deleteLayout(Layout layout)
                           throws SystemException

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

Parameters:: layout - the layout
Returns:: the layout that was removed
Throws:: SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

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

Parameters:: dynamicQuery - the dynamic query
Returns:: the matching rows
Throws:: SystemException - if a system exception occurred

dynamicQuery

public static 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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 static 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.

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 static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:: dynamicQuery - the dynamic query
Returns:: the number of rows that match the dynamic query
Throws:: SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:: dynamicQuery - the dynamic query; projection - the projection to apply to the query
Returns:: the number of rows that match the dynamic query
Throws:: SystemException - if a system exception occurred

fetchLayout

public static Layout fetchLayout(long plid)
                          throws SystemException

Throws:: SystemException

fetchLayoutByUuidAndCompanyId

public static Layout fetchLayoutByUuidAndCompanyId(String uuid,
                                                   long companyId)
                                            throws SystemException

Returns the layout with the matching UUID and company.

Parameters:: uuid - the layout's UUID; companyId - the primary key of the company
Returns:: the matching layout, or null if a matching layout could not be found
Throws:: SystemException - if a system exception occurred

fetchLayoutByUuidAndGroupId

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

Returns the layout matching the UUID, group, and privacy.

Parameters:: uuid - the layout's UUID; groupId - the primary key of the group; privateLayout - whether the layout is private to the group
Returns:: the matching layout, or null if a matching layout could not be found
Throws:: SystemException - if a system exception occurred

getLayout

public static Layout getLayout(long plid)
                        throws PortalException,
                               SystemException

Returns the layout with the primary key.

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 static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:: PortalException; SystemException

getLayoutByUuidAndCompanyId

public static Layout getLayoutByUuidAndCompanyId(String uuid,
                                                 long companyId)
                                          throws PortalException,
                                                 SystemException

Returns the layout with the matching UUID and company.

Parameters:: uuid - the layout's UUID; companyId - the primary key of the company
Returns:: the matching layout
Throws:: PortalException - if a matching layout could not be found; SystemException - if a system exception occurred

getLayoutByUuidAndGroupId

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

Returns the layout matching the UUID, group, and privacy.

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

getLayouts

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

Returns a range of all the layouts.

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 static int getLayoutsCount()
                           throws SystemException

Returns the number of layouts.

Returns:: the number of layouts
Throws:: SystemException - if a system exception occurred

updateLayout

public static 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.

Parameters:: layout - the layout
Returns:: the layout that was updated
Throws:: SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:: the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:: beanIdentifier - the Spring bean ID for this bean

addLayout

public static 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

Deprecated. As of 6.2.0, replaced by addLayout(long, long, boolean, long, Map, Map, Map, Map, Map, String, String, boolean, Map, ServiceContext)

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); 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 to be applied. Must set the 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 determine 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, if layout values were invalid, or if a portal exception occurred; SystemException - if a system exception occurred

addLayout

public static 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,
                               String typeSettings,
                               boolean hidden,
                               Map<Locale,String> friendlyURLMap,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Adds a layout with additional parameters.

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.; typeSettings - the settings to load the unicode properties object. See #fastLoad(String).; hidden - whether the layout is hidden; friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).; serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be 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 determine 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, if layout values were invalid, or if a portal exception occurred; SystemException - if a system exception occurred

addLayout

public static 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 with single entry maps for name, title, and description to the default locale.

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 to be applied. Must set the 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, or if a portal exception occurred; SystemException - if a system exception occurred

deleteLayout

public static 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 to be applied
Throws:: PortalException - if a portal exception occurred; SystemException - if a system exception occurred

deleteLayout

public static 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 to be applied
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 static 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 to be applied
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 static 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 to be applied. The parent layout set's page count will be updated by default, unless an attribute named updatePageCount is set to false.
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 static 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 static 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 static 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

exportLayoutsAsFileInBackground

public static long exportLayoutsAsFileInBackground(long userId,
                                                   String taskName,
                                                   long groupId,
                                                   boolean privateLayout,
                                                   long[] layoutIds,
                                                   Map<String,String[]> parameterMap,
                                                   Date startDate,
                                                   Date endDate,
                                                   String fileName)
                                            throws PortalException,
                                                   SystemException

Throws:: PortalException; SystemException

exportPortletInfo

public static 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

exportPortletInfo

public static byte[] exportPortletInfo(long companyId,
                                       String portletId,
                                       Map<String,String[]> parameterMap,
                                       Date startDate,
                                       Date endDate)
                                throws PortalException,
                                       SystemException

Throws:: PortalException; SystemException

exportPortletInfoAsFile

public static 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

exportPortletInfoAsFile

public static File exportPortletInfoAsFile(long companyId,
                                           String portletId,
                                           Map<String,String[]> parameterMap,
                                           Date startDate,
                                           Date endDate)
                                    throws PortalException,
                                           SystemException

Throws:: PortalException; SystemException

exportPortletInfoAsFileInBackground

public static long exportPortletInfoAsFileInBackground(long userId,
                                                       String taskName,
                                                       long plid,
                                                       long groupId,
                                                       String portletId,
                                                       Map<String,String[]> parameterMap,
                                                       Date startDate,
                                                       Date endDate,
                                                       String fileName)
                                                throws PortalException,
                                                       SystemException

Throws:: PortalException; SystemException

exportPortletInfoAsFileInBackground

public static long exportPortletInfoAsFileInBackground(long userId,
                                                       String taskName,
                                                       String portletId,
                                                       Map<String,String[]> parameterMap,
                                                       Date startDate,
                                                       Date endDate,
                                                       String fileName)
                                                throws PortalException,
                                                       SystemException

Throws:: PortalException; SystemException

fetchFirstLayout

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

Throws:: SystemException

fetchLayout

public static Layout fetchLayout(long groupId,
                                 boolean privateLayout,
                                 long layoutId)
                          throws SystemException

Throws:: SystemException

fetchLayoutByFriendlyURL

public static Layout fetchLayoutByFriendlyURL(long groupId,
                                              boolean privateLayout,
                                              String friendlyURL)
                                       throws SystemException

Throws:: SystemException

getDefaultPlid

public static 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 static 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 static 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 static 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 static 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 static 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 static 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 static 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 static 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.

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 static 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 an empty list 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 static 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 static 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

getLayoutsByLayoutPrototypeUuid

public static List<Layout> getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid)
                                                    throws SystemException

Throws:: SystemException

getLayoutsByLayoutPrototypeUuidCount

public static int getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid)
                                                throws SystemException

Throws:: SystemException

getLayoutsCount

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

Throws:: PortalException; SystemException

getLayoutsCount

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

Throws:: PortalException; SystemException

getLayoutsCount

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

Throws:: PortalException; SystemException

getLayoutsCount

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

Throws:: PortalException; SystemException

getNextLayoutId

public static 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

getNoPermissionLayouts

public static List<Layout> getNoPermissionLayouts(long roleId)
                                           throws SystemException

Returns all the layouts without resource permissions

Parameters:: roleId - the primary key of the role
Returns:: all the layouts without resource permissions
Throws:: SystemException - if a system exception occurred

getNullFriendlyURLLayouts

public static 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

getParentLayout

public static Layout getParentLayout(Layout layout)
                              throws PortalException,
                                     SystemException

Throws:: PortalException; SystemException

getScopeGroupLayouts

public static 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 static boolean hasLayouts(Group group,
                                 boolean privateLayout)
                          throws PortalException,
                                 SystemException

Throws:: PortalException; SystemException

hasLayouts

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

Throws:: PortalException; SystemException

hasLayouts

public static 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 static boolean hasLayouts(User user,
                                 boolean privateLayout)
                          throws PortalException,
                                 SystemException

Throws:: PortalException; SystemException

hasLayouts

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

Throws:: PortalException; SystemException

hasLayoutSetPrototypeLayout

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

Throws:: PortalException; SystemException

hasLayoutSetPrototypeLayout

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

Throws:: PortalException; SystemException

importLayouts

public static 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 static 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 static 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

importLayoutsInBackground

public static long importLayoutsInBackground(long userId,
                                             String taskName,
                                             long groupId,
                                             boolean privateLayout,
                                             Map<String,String[]> parameterMap,
                                             File file)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

importLayoutsInBackground

public static long importLayoutsInBackground(long userId,
                                             String taskName,
                                             long groupId,
                                             boolean privateLayout,
                                             Map<String,String[]> parameterMap,
                                             InputStream is)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

importPortletInfo

public static 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 static 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

importPortletInfo

public static void importPortletInfo(long userId,
                                     String portletId,
                                     Map<String,String[]> parameterMap,
                                     File file)
                              throws PortalException,
                                     SystemException

Throws:: PortalException; SystemException

importPortletInfo

public static void importPortletInfo(long userId,
                                     String portletId,
                                     Map<String,String[]> parameterMap,
                                     InputStream is)
                              throws PortalException,
                                     SystemException

Throws:: PortalException; SystemException

importPortletInfoInBackground

public static long importPortletInfoInBackground(long userId,
                                                 String taskName,
                                                 long plid,
                                                 long groupId,
                                                 String portletId,
                                                 Map<String,String[]> parameterMap,
                                                 File file)
                                          throws PortalException,
                                                 SystemException

Throws:: PortalException; SystemException

importPortletInfoInBackground

public static long importPortletInfoInBackground(long userId,
                                                 String taskName,
                                                 long plid,
                                                 long groupId,
                                                 String portletId,
                                                 Map<String,String[]> parameterMap,
                                                 InputStream is)
                                          throws PortalException,
                                                 SystemException

Throws:: PortalException; SystemException

importPortletInfoInBackground

public static long importPortletInfoInBackground(long userId,
                                                 String taskName,
                                                 String portletId,
                                                 Map<String,String[]> parameterMap,
                                                 File file)
                                          throws PortalException,
                                                 SystemException

Throws:: PortalException; SystemException

importPortletInfoInBackground

public static long importPortletInfoInBackground(long userId,
                                                 String taskName,
                                                 String portletId,
                                                 Map<String,String[]> parameterMap,
                                                 InputStream is)
                                          throws PortalException,
                                                 SystemException

Throws:: PortalException; SystemException

setLayouts

public static 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 to be applied
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 static Layout updateFriendlyURL(long plid,
                                       String friendlyURL,
                                       String languageId)
                                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; languageId - the primary key of the language
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 static 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,
                                  Map<Locale,String> friendlyURLMap,
                                  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; friendlyURLMap - the layout's locales and localized friendly URLs. 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 to be applied. 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 determine 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, if the layout parameters were invalid, or if a portal exception occurred; SystemException - if a system exception occurred

updateLayout

public static 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

Deprecated. As of 6.2.0, replaced by updateLayout(long, boolean, long, long, Map, Map, Map, Map, Map, String, boolean, Map, Boolean, byte[], ServiceContext)

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 to be applied. 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 determine 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, if the layout parameters were invalid, or if a portal exception occurred; SystemException - if a system exception occurred

updateLayout

public static 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 or if a portal exception occurred; SystemException - if a system exception occurred

updateLookAndFeel

public static 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 static 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 static 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 static 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 static 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 static 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

updateParentLayoutIdAndPriority

public static Layout updateParentLayoutIdAndPriority(long plid,
                                                     long parentPlid,
                                                     int priority)
                                              throws PortalException,
                                                     SystemException

Throws:: PortalException; SystemException

updatePriorities

public static 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 static Layout updatePriority(Layout layout,
                                    int priority)
                             throws PortalException,
                                    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:: PortalException - if a portal exception occurred; SystemException - if a system exception occurred

updatePriority

public static 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 static Layout updatePriority(long groupId,
                                    boolean privateLayout,
                                    long layoutId,
                                    long nextLayoutId,
                                    long previousLayoutId)
                             throws PortalException,
                                    SystemException

Updates the priority of the layout matching the group, layout ID, and privacy, setting the layout's priority based on the priorities of the next and previous layouts.

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

updatePriority

public static 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 static 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 static 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 UUID, 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 UUID 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:: com.liferay.portlet.portletconfiguration.action.EditScopeAction

validateImportLayoutsFile

public static MissingReferences validateImportLayoutsFile(long userId,
                                                          long groupId,
                                                          boolean privateLayout,
                                                          Map<String,String[]> parameterMap,
                                                          File file)
                                                   throws PortalException,
                                                          SystemException

Throws:: PortalException; SystemException

validateImportLayoutsFile

public static MissingReferences validateImportLayoutsFile(long userId,
                                                          long groupId,
                                                          boolean privateLayout,
                                                          Map<String,String[]> parameterMap,
                                                          InputStream inputStream)
                                                   throws PortalException,
                                                          SystemException

Throws:: PortalException; SystemException

validateImportPortletInfo

public static MissingReferences validateImportPortletInfo(long userId,
                                                          long plid,
                                                          long groupId,
                                                          String portletId,
                                                          Map<String,String[]> parameterMap,
                                                          File file)
                                                   throws PortalException,
                                                          SystemException

Throws:: PortalException; SystemException

validateImportPortletInfo

public static MissingReferences validateImportPortletInfo(long userId,
                                                          long plid,
                                                          long groupId,
                                                          String portletId,
                                                          Map<String,String[]> parameterMap,
                                                          InputStream inputStream)
                                                   throws PortalException,
                                                          SystemException

Throws:: PortalException; SystemException

getService

public static LayoutLocalService getService()

setService

public void setService(LayoutLocalService service)

Deprecated. As of 6.2.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.2-ce-ga5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service Class LayoutLocalServiceUtil

LayoutLocalServiceUtil

addLayout

createLayout

deleteLayout

deleteLayout

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

fetchLayout

fetchLayoutByUuidAndCompanyId

fetchLayoutByUuidAndGroupId

getLayout

getPersistedModel

getLayoutByUuidAndCompanyId

getLayoutByUuidAndGroupId

getLayouts

getLayoutsCount

updateLayout

getBeanIdentifier

setBeanIdentifier

addLayout

addLayout

addLayout

deleteLayout

deleteLayout

deleteLayout

deleteLayouts

exportLayouts

exportLayouts

exportLayoutsAsFile

exportLayoutsAsFileInBackground

exportPortletInfo

exportPortletInfo

exportPortletInfoAsFile

exportPortletInfoAsFile

exportPortletInfoAsFileInBackground

exportPortletInfoAsFileInBackground

fetchFirstLayout

fetchLayout

fetchLayoutByFriendlyURL

getDefaultPlid

getDefaultPlid

getDefaultPlid

getFriendlyURLLayout

getLayout

getLayoutByIconImageId

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayoutsByLayoutPrototypeUuid

getLayoutsByLayoutPrototypeUuidCount

getLayoutsCount

getLayoutsCount

getLayoutsCount

getLayoutsCount

getNextLayoutId

getNoPermissionLayouts

getNullFriendlyURLLayouts

getParentLayout

getScopeGroupLayouts

hasLayouts

hasLayouts

hasLayouts

hasLayouts

hasLayouts

hasLayoutSetPrototypeLayout

hasLayoutSetPrototypeLayout

importLayouts

importLayouts

importLayouts

importLayoutsInBackground

importLayoutsInBackground

importPortletInfo

com.liferay.portal.service
Class LayoutLocalServiceUtil