|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.LayoutLocalServiceUtil
@ProviderType public class LayoutLocalServiceUtil
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.
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 PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
static DynamicQuery |
dynamicQuery()
|
|
static
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> 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 matching the dynamic query. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
static byte[] |
exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
|
static byte[] |
exportLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
|
static File |
exportLayoutsAsFile(ExportImportConfiguration exportImportConfiguration)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.exportLayoutsAsFile(
ExportImportConfiguration) |
|
static File |
exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
|
static long |
exportLayoutsAsFileInBackground(long userId,
ExportImportConfiguration exportImportConfiguration)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.exportLayoutsAsFileInBackground(
long, ExportImportConfiguration) |
|
static long |
exportLayoutsAsFileInBackground(long userId,
long exportImportConfigurationId)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.exportLayoutsAsFileInBackground(
long, long) |
|
static long |
exportLayoutsAsFileInBackground(long userId,
String taskName,
long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
|
static long |
exportLayoutsAsFileInBackground(long userId,
String taskName,
long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
Deprecated. As of 7.0.0, with no direct replacement |
|
static byte[] |
exportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
|
static byte[] |
exportPortletInfo(long companyId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
|
static File |
exportPortletInfoAsFile(ExportImportConfiguration exportImportConfiguration)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.exportPortletInfoAsFile(
ExportImportConfiguration)} |
|
static File |
exportPortletInfoAsFile(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
|
static File |
exportPortletInfoAsFile(long companyId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
|
static long |
exportPortletInfoAsFileInBackground(long userId,
ExportImportConfiguration exportImportConfiguration)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.exportPortletInfoAsFileInBackground(
long, ExportImportConfiguration)} |
|
static long |
exportPortletInfoAsFileInBackground(long userId,
long exportImportConfigurationId)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.exportPortletInfoAsFileInBackground(
long, long)} |
|
static long |
exportPortletInfoAsFileInBackground(long userId,
String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
Deprecated. As of 7.0.0, with no direct replacement |
|
static long |
exportPortletInfoAsFileInBackground(long userId,
String taskName,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
Deprecated. As of 7.0.0, with no direct replacement |
|
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 |
fetchLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
Returns the layout matching the UUID, group, and privacy. |
|
static ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
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 ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext)
|
|
static Layout |
getFriendlyURLLayout(long groupId,
boolean privateLayout,
String friendlyURL)
Returns the layout for the friendly URL |
|
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery()
|
|
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 |
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 List<Layout> |
getLayoutsByUuidAndCompanyId(String uuid,
long companyId)
Returns all the layouts matching the UUID and company. |
|
static List<Layout> |
getLayoutsByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<Layout> orderByComparator)
Returns a range of layouts matching the UUID and company. |
|
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(Group group,
boolean privateLayout,
long parentLayoutId)
|
|
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 String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
|
static Layout |
getParentLayout(Layout layout)
|
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
static List<Layout> |
getScopeGroupLayouts(long parentGroupId)
|
|
static List<Layout> |
getScopeGroupLayouts(long parentGroupId,
boolean privateLayout)
Returns all the layouts within scope of the group |
|
static LayoutLocalService |
getService()
|
|
static boolean |
hasLayouts(Group group)
|
|
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(ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.importLayouts(
ExportImportConfiguration, File)} |
|
static void |
importLayouts(ExportImportConfiguration exportImportConfiguration,
InputStream is)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.importLayouts(
ExportImportConfiguration, InputStream)} |
|
static void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
byte[] bytes)
Deprecated. As of 7.0.0, with no direct replacement |
|
static void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
|
static void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
|
static void |
importLayoutsDataDeletions(ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.importLayoutsDataDeletions(
ExportImportConfiguration, File) |
|
static long |
importLayoutsInBackground(long userId,
ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.importLayoutsInBackground(
long, ExportImportConfiguration, File) |
|
static long |
importLayoutsInBackground(long userId,
long exportImportConfigurationId,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.importLayoutsInBackground(
long, long, File) |
|
static long |
importLayoutsInBackground(long userId,
String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
|
static long |
importLayoutsInBackground(long userId,
String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
|
static void |
importPortletDataDeletions(ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.importPortletDataDeletions(
ExportImportConfiguration, File) |
|
static void |
importPortletInfo(ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.importPortletInfo(
ExportImportConfiguration, File) |
|
static void |
importPortletInfo(ExportImportConfiguration exportImportConfiguration,
InputStream is)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.importPortletInfo(
ExportImportConfiguration, InputStream) |
|
static void |
importPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
|
static void |
importPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
|
static void |
importPortletInfo(long userId,
String portletId,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
|
static void |
importPortletInfo(long userId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
|
static long |
importPortletInfoInBackground(long userId,
ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.importPortletInfoInBackground(
long, ExportImportConfiguration, File) |
|
static long |
importPortletInfoInBackground(long userId,
long exportImportConfigurationId,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.importPortletInfoInBackground(
long, long, File) |
|
static long |
importPortletInfoInBackground(long userId,
String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
|
static long |
importPortletInfoInBackground(long userId,
String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
|
static long |
importPortletInfoInBackground(long userId,
String taskName,
String portletId,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
|
static long |
importPortletInfoInBackground(long userId,
String taskName,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
|
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. |
|
static void |
updateAsset(long userId,
Layout layout,
long[] assetCategoryIds,
String[] assetTagNames)
|
|
static Layout |
updateFriendlyURL(long userId,
long plid,
String friendlyURL,
String languageId)
Updates the friendly URL of the layout. |
|
static Layout |
updateFriendlyURL(long plid,
String friendlyURL,
String languageId)
Deprecated. As of 7.0.0, replaced by updateFriendlyURL(long,
long, String, String) |
|
static Layout |
updateIconImage(long plid,
byte[] bytes)
|
|
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)
Updates the parent layout ID and priority of the layout. |
|
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(ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.validateImportLayoutsFile(
ExportImportConfiguration, File) |
|
static MissingReferences |
validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
InputStream inputStream)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.validateImportLayoutsFile(
ExportImportConfiguration, InputStream) |
|
static MissingReferences |
validateImportLayoutsFile(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
|
static MissingReferences |
validateImportLayoutsFile(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream inputStream)
Deprecated. As of 7.0.0, with no direct replacement |
|
static MissingReferences |
validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.validateImportPortletInfo(
ExportImportConfiguration, File) |
|
static MissingReferences |
validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
InputStream inputStream)
Deprecated. As of 7.0.0, replaced by ExportImportLocalService.validateImportPortletInfo(
ExportImportConfiguration, InputStream) |
|
static MissingReferences |
validateImportPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
|
static MissingReferences |
validateImportPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream inputStream)
Deprecated. As of 7.0.0, with no direct replacement |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public LayoutLocalServiceUtil()
| Method Detail |
|---|
public static Layout addLayout(Layout layout)
layout - the layout
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
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.
userId - the primary key of the usergroupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparentLayoutId - 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
PropsValuestitle - the layout's titledescription - the layout's descriptiontype - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found
in LayoutConstants.hidden - whether the layout is hiddenfriendlyURL - 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.
PortalException
@Deprecated
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
addLayout(long, long,
boolean, long, Map, Map, Map, Map, Map, String, String,
boolean, Map, ServiceContext)
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.
userId - the primary key of the usergroupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparentLayoutId - the primary key of the parent layout
(optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)nameMap - the layout's locales and localized namestitleMap - the layout's locales and localized titlesdescriptionMap - the layout's locales and localized
descriptionskeywordsMap - the layout's locales and localized keywordsrobotsMap - the layout's locales and localized robotstype - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be
found in LayoutConstants.hidden - whether the layout is hiddenfriendlyURL - 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.
PortalException
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
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.
userId - the primary key of the usergroupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparentLayoutId - the primary key of the parent layout (optionally
LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)nameMap - the layout's locales and localized namestitleMap - the layout's locales and localized titlesdescriptionMap - the layout's locales and localized descriptionskeywordsMap - the layout's locales and localized keywordsrobotsMap - the layout's locales and localized robotstype - 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 hiddenfriendlyURLMap - 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.
PortalExceptionpublic static Layout createLayout(long plid)
plid - the primary key for the new layout
public static void deleteLayout(long groupId,
boolean privateLayout,
long layoutId,
ServiceContext serviceContext)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutserviceContext - the service context to be applied
PortalExceptionpublic static Layout deleteLayout(Layout layout)
layout - the layout
public static void deleteLayout(Layout layout,
boolean updateLayoutSet,
ServiceContext serviceContext)
throws PortalException
layout - the layoutupdateLayoutSet - whether the layout set's page counter needs to be
updatedserviceContext - the service context to be applied
PortalException
public static Layout deleteLayout(long plid)
throws PortalException
plid - the primary key of the layout
PortalException - if a layout with the primary key could not be found
public static void deleteLayout(long plid,
ServiceContext serviceContext)
throws PortalException
plid - the primary key of the layoutserviceContext - the service context to be applied
PortalException
public static void deleteLayouts(long groupId,
boolean privateLayout,
ServiceContext serviceContext)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupserviceContext - 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.
PortalException
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
PortalExceptionpublic static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
@Deprecated
public static byte[] exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutIds - the primary keys of the layouts to be exportedparameterMap - 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 dateendDate - the export's end date
PortalException
@Deprecated
public static byte[] exportLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparameterMap - 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 dateendDate - the export's end date
PortalException
@Deprecated
public static File exportLayoutsAsFile(ExportImportConfiguration exportImportConfiguration)
throws PortalException
ExportImportLocalService.exportLayoutsAsFile(
ExportImportConfiguration)
PortalException
@Deprecated
public static File exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutIds - 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 dateendDate - the export's end date
PortalException
@Deprecated
public static long exportLayoutsAsFileInBackground(long userId,
ExportImportConfiguration exportImportConfiguration)
throws PortalException
ExportImportLocalService.exportLayoutsAsFileInBackground(
long, ExportImportConfiguration)
PortalException
@Deprecated
public static long exportLayoutsAsFileInBackground(long userId,
long exportImportConfigurationId)
throws PortalException
ExportImportLocalService.exportLayoutsAsFileInBackground(
long, long)
PortalException
@Deprecated
public static long exportLayoutsAsFileInBackground(long userId,
String taskName,
long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
PortalException
@Deprecated
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
PortalException
@Deprecated
public static byte[] exportPortletInfo(long companyId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
PortalException
@Deprecated
public static byte[] exportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
plid - the primary key of the layoutgroupId - the primary key of the groupportletId - the primary key of the portletparameterMap - 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 dateendDate - the export's end date
PortalException
@Deprecated
public static File exportPortletInfoAsFile(long companyId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
PortalException
@Deprecated
public static File exportPortletInfoAsFile(ExportImportConfiguration exportImportConfiguration)
throws PortalException
ExportImportLocalService.exportPortletInfoAsFile(
ExportImportConfiguration)}
PortalException
@Deprecated
public static File exportPortletInfoAsFile(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
plid - the primary key of the layoutgroupId - the primary key of the groupportletId - the primary key of the portletparameterMap - 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 dateendDate - the export's end date
PortalException
@Deprecated
public static long exportPortletInfoAsFileInBackground(long userId,
ExportImportConfiguration exportImportConfiguration)
throws PortalException
ExportImportLocalService.exportPortletInfoAsFileInBackground(
long, ExportImportConfiguration)}
PortalException
@Deprecated
public static long exportPortletInfoAsFileInBackground(long userId,
long exportImportConfigurationId)
throws PortalException
ExportImportLocalService.exportPortletInfoAsFileInBackground(
long, long)}
PortalException
@Deprecated
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
PortalException
@Deprecated
public static long exportPortletInfoAsFileInBackground(long userId,
String taskName,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
throws PortalException
PortalException
public static Layout fetchFirstLayout(long groupId,
boolean privateLayout,
long parentLayoutId)
public static Layout fetchLayout(long groupId,
boolean privateLayout,
long layoutId)
public static Layout fetchLayout(long plid)
public static Layout fetchLayoutByFriendlyURL(long groupId,
boolean privateLayout,
String friendlyURL)
public static Layout fetchLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
uuid - the layout's UUIDgroupId - the primary key of the groupprivateLayout - whether the layout is private to the group
null if a matching layout could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static long getDefaultPlid(long groupId)
groupId - the primary key of the group
LayoutConstants#DEFAULT_PLID)
public static long getDefaultPlid(long groupId,
boolean privateLayout)
groupId - the primary key of the groupprivateLayout - whether the layout is private to the group
LayoutConstants#DEFAULT_PLID) otherwise
public static long getDefaultPlid(long groupId,
boolean privateLayout,
String portletId)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupportletId - the primary key of the portlet
LayoutConstants#DEFAULT_PLID otherwise
PortalExceptionpublic static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static Layout getFriendlyURLLayout(long groupId,
boolean privateLayout,
String friendlyURL)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupfriendlyURL - the friendly URL of the layout
PortalExceptionpublic static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static Layout getLayout(long groupId,
boolean privateLayout,
long layoutId)
throws PortalException
NoSuchLayoutException otherwise.
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layout
PortalException
public static Layout getLayout(long plid)
throws PortalException
plid - the primary key of the layout
PortalException - if a layout with the primary key could not be found
public static Layout getLayoutByIconImageId(long iconImageId)
throws PortalException
NoSuchLayoutException otherwise.
iconImageId - the primary key of the icon image
PortalException
public static Layout getLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
throws PortalException
uuid - the layout's UUIDgroupId - the primary key of the groupprivateLayout - whether the layout is private to the group
PortalException - if a matching layout could not be found
public static LayoutReference[] getLayouts(long companyId,
String portletId,
String preferencesKey,
String preferencesValue)
companyId - the primary key of the companyportletId - the primary key of the portletpreferencesKey - the portlet's preference keypreferencesValue - the portlet's preference value
public static List<Layout> getLayouts(long groupId,
boolean privateLayout)
groupId - the primary key of the groupprivateLayout - whether the layout is private to the group
null if no matches were
found
public static List<Layout> getLayouts(long groupId,
boolean privateLayout,
long[] layoutIds)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutIds - the primary keys of the layouts
PortalException
public static List<Layout> getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparentLayoutId - the primary key of the parent layout
null if no matches were
found
public static List<Layout> getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
boolean incomplete,
int start,
int end)
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.
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparentLayoutId - the primary key of the parent layoutincomplete - whether the layout is incompletestart - the lower bound of the range of layoutsend - the upper bound of the range of layouts (not inclusive)
null if no matches were
found
public static List<Layout> getLayouts(long groupId,
boolean privateLayout,
String type)
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouptype - the type of the layouts (optionally LayoutConstants#TYPE_PORTLET)
null if no matches were
found
public static List<Layout> getLayouts(int start,
int end)
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.
start - the lower bound of the range of layoutsend - the upper bound of the range of layouts (not inclusive)
public static List<Layout> getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid)
public static int getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid)
public static List<Layout> getLayoutsByUuidAndCompanyId(String uuid,
long companyId)
uuid - the UUID of the layoutscompanyId - the primary key of the company
public static List<Layout> getLayoutsByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<Layout> orderByComparator)
uuid - the UUID of the layoutscompanyId - the primary key of the companystart - the lower bound of the range of layoutsend - the upper bound of the range of layouts (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
public static int getLayoutsCount()
public static int getLayoutsCount(Group group,
boolean privateLayout)
throws PortalException
PortalException
public static int getLayoutsCount(Group group,
boolean privateLayout,
boolean includeUserGroups)
throws PortalException
PortalException
public static int getLayoutsCount(Group group,
boolean privateLayout,
long parentLayoutId)
public static int getLayoutsCount(User user,
boolean privateLayout)
throws PortalException
PortalException
public static int getLayoutsCount(User user,
boolean privateLayout,
boolean includeUserGroups)
throws PortalException
PortalException
public static long getNextLayoutId(long groupId,
boolean privateLayout)
groupId - the primary key of the groupprivateLayout - whether the layout is private to the group
public static List<Layout> getNoPermissionLayouts(long roleId)
roleId - the primary key of the role
public static List<Layout> getNullFriendlyURLLayouts()
null
nullpublic static String getOSGiServiceIdentifier()
public static Layout getParentLayout(Layout layout)
throws PortalException
PortalException
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
PortalException
public static List<Layout> getScopeGroupLayouts(long parentGroupId)
throws PortalException
PortalException
public static List<Layout> getScopeGroupLayouts(long parentGroupId,
boolean privateLayout)
throws PortalException
privateLayout - whether the layout is private to the group
PortalException
public static boolean hasLayoutSetPrototypeLayout(long layoutSetPrototypeId,
String layoutUuid)
throws PortalException
PortalException
public static boolean hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid,
long companyId,
String layoutUuid)
throws PortalException
PortalException
public static boolean hasLayouts(Group group)
throws PortalException
PortalException
public static boolean hasLayouts(Group group,
boolean privateLayout)
throws PortalException
PortalException
public static boolean hasLayouts(Group group,
boolean privateLayout,
boolean includeUserGroups)
throws PortalException
PortalException
public static boolean hasLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
true if the group has any layouts;
false otherwise.
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparentLayoutId - the primary key of the parent layout
true if the group has any layouts;
false otherwise
public static boolean hasLayouts(User user,
boolean privateLayout)
throws PortalException
PortalException
public static boolean hasLayouts(User user,
boolean privateLayout,
boolean includeUserGroups)
throws PortalException
PortalException
@Deprecated
public static void importLayouts(ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportLocalService.importLayouts(
ExportImportConfiguration, File)}
PortalException
@Deprecated
public static void importLayouts(ExportImportConfiguration exportImportConfiguration,
InputStream is)
throws PortalException
ExportImportLocalService.importLayouts(
ExportImportConfiguration, InputStream)}
PortalException
@Deprecated
public static void importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
byte[] bytes)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparameterMap - 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
PortalExceptioncom.liferay.portlet.exportimport.lar.LayoutImporter
@Deprecated
public static void importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparameterMap - 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
PortalExceptioncom.liferay.portlet.exportimport.lar.LayoutImporter
@Deprecated
public static void importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparameterMap - 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
PortalExceptioncom.liferay.portlet.exportimport.lar.LayoutImporter
@Deprecated
public static void importLayoutsDataDeletions(ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportLocalService.importLayoutsDataDeletions(
ExportImportConfiguration, File)
PortalException
@Deprecated
public static long importLayoutsInBackground(long userId,
ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportLocalService.importLayoutsInBackground(
long, ExportImportConfiguration, File)
PortalException
@Deprecated
public static long importLayoutsInBackground(long userId,
long exportImportConfigurationId,
File file)
throws PortalException
ExportImportLocalService.importLayoutsInBackground(
long, long, File)
PortalException
@Deprecated
public static long importLayoutsInBackground(long userId,
String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public static long importLayoutsInBackground(long userId,
String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
PortalException
@Deprecated
public static void importPortletDataDeletions(ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportLocalService.importPortletDataDeletions(
ExportImportConfiguration, File)
PortalException
@Deprecated
public static void importPortletInfo(ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportLocalService.importPortletInfo(
ExportImportConfiguration, File)
PortalException
@Deprecated
public static void importPortletInfo(ExportImportConfiguration exportImportConfiguration,
InputStream is)
throws PortalException
ExportImportLocalService.importPortletInfo(
ExportImportConfiguration, InputStream)
PortalException
@Deprecated
public static void importPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException
userId - the primary key of the userplid - the primary key of the target layoutgroupId - the primary key of the target groupportletId - the primary key of the portletparameterMap - 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
PortalException
@Deprecated
public static void importPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
userId - the primary key of the userplid - the primary key of the layoutgroupId - the primary key of the groupportletId - the primary key of the portletparameterMap - 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
PortalException
@Deprecated
public static void importPortletInfo(long userId,
String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public static void importPortletInfo(long userId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
PortalException
@Deprecated
public static long importPortletInfoInBackground(long userId,
ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportLocalService.importPortletInfoInBackground(
long, ExportImportConfiguration, File)
PortalException
@Deprecated
public static long importPortletInfoInBackground(long userId,
long exportImportConfigurationId,
File file)
throws PortalException
ExportImportLocalService.importPortletInfoInBackground(
long, long, File)
PortalException
@Deprecated
public static long importPortletInfoInBackground(long userId,
String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public static long importPortletInfoInBackground(long userId,
String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
PortalException
@Deprecated
public static long importPortletInfoInBackground(long userId,
String taskName,
String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public static long importPortletInfoInBackground(long userId,
String taskName,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
PortalException
public static void setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds,
ServiceContext serviceContext)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparentLayoutId - the primary key of the parent layoutlayoutIds - the primary keys of the layoutsserviceContext - the service context to be applied
PortalException
public static void updateAsset(long userId,
Layout layout,
long[] assetCategoryIds,
String[] assetTagNames)
throws PortalException
PortalException
@Deprecated
public static Layout updateFriendlyURL(long plid,
String friendlyURL,
String languageId)
throws PortalException
updateFriendlyURL(long,
long, String, String)
plid - the primary key of the layoutfriendlyURL - the friendly URL to be assignedlanguageId - the primary key of the language
PortalException
public static Layout updateFriendlyURL(long userId,
long plid,
String friendlyURL,
String languageId)
throws PortalException
userId - the primary key of the userplid - the primary key of the layoutfriendlyURL - the friendly URL to be assignedlanguageId - the primary key of the language
PortalException
public static Layout updateIconImage(long plid,
byte[] bytes)
throws PortalException
PortalException
@Deprecated
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
updateLayout(long, boolean,
long, long, Map, Map, Map, Map, Map, String, boolean, Map,
boolean, byte[], ServiceContext)
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutparentLayoutId - the primary key of the layout's new parent
layoutnameMap - 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 hiddenfriendlyURL - 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 updatediconBytes - the byte array of the layout's new icon imageserviceContext - 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.
PortalException
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
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutparentLayoutId - the primary key of the layout's new parent layoutnameMap - 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 hiddenfriendlyURLMap - 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 updatediconBytes - the byte array of the layout's new icon imageserviceContext - 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.
PortalException
public static Layout updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layouttypeSettings - the settings to load the unicode properties object.
See #fastLoad(String).
PortalExceptionpublic static Layout updateLayout(Layout layout)
layout - the layout
public static Layout updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
String themeId,
String colorSchemeId,
String css,
boolean wapTheme)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutthemeId - the primary key of the layout's new themecolorSchemeId - the primary key of the layout's new color schemecss - the layout's new CSSwapTheme - whether the theme is for WAP browsers
PortalException
public static Layout updateName(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutname - the layout's new namelanguageId - the primary key of the language. For more information
see Locale.
PortalException
public static Layout updateName(Layout layout,
String name,
String languageId)
throws PortalException
layout - the layout to be updatedname - the layout's new namelanguageId - the primary key of the language. For more information
see Locale.
PortalException
public static Layout updateName(long plid,
String name,
String languageId)
throws PortalException
plid - the primary key of the layoutname - the name to be assignedlanguageId - the primary key of the language. For more information
see Locale.
PortalException
public static Layout updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutparentLayoutId - the primary key to be assigned to the parent
layout
PortalException
public static Layout updateParentLayoutId(long plid,
long parentPlid)
throws PortalException
LayoutConstants#DEFAULT_PARENT_LAYOUT_ID is assigned.
plid - the primary key of the layoutparentPlid - the primary key of the parent layout
PortalException
public static Layout updateParentLayoutIdAndPriority(long plid,
long parentPlid,
int priority)
throws PortalException
plid - the primary key of the layoutparentPlid - the primary key of the parent layoutpriority - the layout's new priority
PortalException
public static void updatePriorities(long groupId,
boolean privateLayout)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the group
PortalException
public static Layout updatePriority(long groupId,
boolean privateLayout,
long layoutId,
long nextLayoutId,
long previousLayoutId)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutnextLayoutId - the primary key of the next layoutpreviousLayoutId - the primary key of the previous layout
PortalException
public static Layout updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutpriority - the layout's new priority
PortalException
public static Layout updatePriority(Layout layout,
int priority)
throws PortalException
layout - the layout to be updatedpriority - the layout's new priority
PortalException
public static Layout updatePriority(long plid,
int priority)
throws PortalException
plid - the primary key of the layoutpriority - the layout's new priority
PortalException
@Deprecated
public static void updateScopedPortletNames(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layout whose UUID to matchname - the new name for the portletslanguageId - the primary key of the language
PortalExceptioncom.liferay.portlet.portletconfiguration.action.EditScopeAction
@Deprecated
public static void updateScopedPortletNames(long groupId,
boolean privateLayout,
long layoutId,
Map<Locale,String> nameMap,
List<Locale> nameMapModifiedLocales)
throws PortalException
PortalException
@Deprecated
public static MissingReferences validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportLocalService.validateImportLayoutsFile(
ExportImportConfiguration, File)
PortalException
@Deprecated
public static MissingReferences validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
InputStream inputStream)
throws PortalException
ExportImportLocalService.validateImportLayoutsFile(
ExportImportConfiguration, InputStream)
PortalException
@Deprecated
public static MissingReferences validateImportLayoutsFile(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public static MissingReferences validateImportLayoutsFile(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream inputStream)
throws PortalException
PortalException
@Deprecated
public static MissingReferences validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportLocalService.validateImportPortletInfo(
ExportImportConfiguration, File)
PortalException
@Deprecated
public static MissingReferences validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
InputStream inputStream)
throws PortalException
ExportImportLocalService.validateImportPortletInfo(
ExportImportConfiguration, InputStream)
PortalException
@Deprecated
public static MissingReferences validateImportPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public static MissingReferences validateImportPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream inputStream)
throws PortalException
PortalExceptionpublic static LayoutLocalService getService()
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||