@ProviderType
public class LayoutLocalServiceUtil
extends java.lang.Object
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 and Description |
|---|
LayoutLocalServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static Layout |
addLayout(Layout layout)
Adds the layout to the database.
|
static Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Map<java.util.Locale,java.lang.String> keywordsMap,
java.util.Map<java.util.Locale,java.lang.String> robotsMap,
java.lang.String type,
boolean hidden,
java.lang.String friendlyURL,
ServiceContext serviceContext)
Deprecated.
|
static Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Map<java.util.Locale,java.lang.String> keywordsMap,
java.util.Map<java.util.Locale,java.lang.String> robotsMap,
java.lang.String type,
java.lang.String typeSettings,
boolean hidden,
java.util.Map<java.util.Locale,java.lang.String> friendlyURLMap,
ServiceContext serviceContext)
Adds a layout with additional parameters.
|
static Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String type,
boolean hidden,
java.lang.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 java.util.List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static java.util.List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
static java.util.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,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
Exports layouts with the primary keys and criteria as a byte array.
|
static byte[] |
exportLayouts(long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
Exports all layouts that match the criteria as a byte array.
|
static java.io.File |
exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
Exports the layouts that match the primary keys and criteria as a file.
|
static long |
exportLayoutsAsFileInBackground(long userId,
java.lang.String taskName,
long groupId,
boolean privateLayout,
long[] layoutIds,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String fileName) |
static byte[] |
exportPortletInfo(long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
Exports the portlet information (categories, permissions, ... etc.) as a
byte array.
|
static byte[] |
exportPortletInfo(long companyId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate) |
static java.io.File |
exportPortletInfoAsFile(long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
Exports the portlet information (categories, permissions, ... etc.) as a
file.
|
static java.io.File |
exportPortletInfoAsFile(long companyId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate) |
static long |
exportPortletInfoAsFileInBackground(long userId,
java.lang.String taskName,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String fileName) |
static long |
exportPortletInfoAsFileInBackground(long userId,
java.lang.String taskName,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate,
java.lang.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,
java.lang.String friendlyURL) |
static Layout |
fetchLayoutByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the layout with the matching UUID and company.
|
static Layout |
fetchLayoutByUuidAndGroupId(java.lang.String uuid,
long groupId,
boolean privateLayout)
Returns the layout matching the UUID, group, and privacy.
|
static java.lang.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,
java.lang.String portletId)
Returns primary key of the default portlet layout for the group
|
static Layout |
getFriendlyURLLayout(long groupId,
boolean privateLayout,
java.lang.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(java.lang.String uuid,
long companyId)
Returns the layout with the matching UUID and company.
|
static Layout |
getLayoutByUuidAndGroupId(java.lang.String uuid,
long groupId,
boolean privateLayout)
Returns the layout matching the UUID, group, and privacy.
|
static java.util.List<Layout> |
getLayouts(int start,
int end)
Returns a range of all the layouts.
|
static java.util.List<Layout> |
getLayouts(long groupId,
boolean privateLayout)
Returns all the layouts belonging to the group.
|
static java.util.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 java.util.List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long[] layoutIds)
Returns all the layouts that match the layout IDs and belong to the
group.
|
static java.util.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 java.util.List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
java.lang.String type)
Returns all the layouts that match the type and belong to the group.
|
static LayoutReference[] |
getLayouts(long companyId,
java.lang.String portletId,
java.lang.String preferencesKey,
java.lang.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 java.util.List<Layout> |
getLayoutsByLayoutPrototypeUuid(java.lang.String layoutPrototypeUuid) |
static int |
getLayoutsByLayoutPrototypeUuidCount(java.lang.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 java.util.List<Layout> |
getNoPermissionLayouts(long roleId)
Returns all the layouts without resource permissions
|
static java.util.List<Layout> |
getNullFriendlyURLLayouts()
Returns all the layouts whose friendly URLs are
null |
static Layout |
getParentLayout(Layout layout) |
static PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static java.util.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,
java.lang.String layoutUuid) |
static boolean |
hasLayoutSetPrototypeLayout(java.lang.String layoutSetPrototypeUuid,
long companyId,
java.lang.String layoutUuid) |
static void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
byte[] bytes)
Imports the layouts from the byte array.
|
static void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file)
Imports the layouts from the file.
|
static void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is)
Imports the layouts from the input stream.
|
static long |
importLayoutsInBackground(long userId,
java.lang.String taskName,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file) |
static long |
importLayoutsInBackground(long userId,
java.lang.String taskName,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is) |
static void |
importPortletInfo(long userId,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file)
Imports the portlet information (categories, permissions, ... etc.) from
the file.
|
static void |
importPortletInfo(long userId,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is)
Imports the portlet information (categories, permissions, ... etc.) from
the input stream.
|
static void |
importPortletInfo(long userId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file) |
static void |
importPortletInfo(long userId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is) |
static long |
importPortletInfoInBackground(long userId,
java.lang.String taskName,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file) |
static long |
importPortletInfoInBackground(long userId,
java.lang.String taskName,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is) |
static long |
importPortletInfoInBackground(long userId,
java.lang.String taskName,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file) |
static long |
importPortletInfoInBackground(long userId,
java.lang.String taskName,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is) |
static void |
setBeanIdentifier(java.lang.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,
java.lang.String friendlyURL,
java.lang.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,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Map<java.util.Locale,java.lang.String> keywordsMap,
java.util.Map<java.util.Locale,java.lang.String> robotsMap,
java.lang.String type,
boolean hidden,
java.util.Map<java.util.Locale,java.lang.String> friendlyURLMap,
java.lang.Boolean iconImage,
byte[] iconBytes,
ServiceContext serviceContext)
Updates the layout.
|
static Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Map<java.util.Locale,java.lang.String> keywordsMap,
java.util.Map<java.util.Locale,java.lang.String> robotsMap,
java.lang.String type,
boolean hidden,
java.lang.String friendlyURL,
java.lang.Boolean iconImage,
byte[] iconBytes,
ServiceContext serviceContext)
Deprecated.
|
static Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String typeSettings)
Updates the layout replacing its type settings.
|
static Layout |
updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String themeId,
java.lang.String colorSchemeId,
java.lang.String css,
boolean wapTheme)
Updates the look and feel of the layout.
|
static Layout |
updateName(Layout layout,
java.lang.String name,
java.lang.String languageId)
Updates the name of the layout.
|
static Layout |
updateName(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String name,
java.lang.String languageId)
Updates the name of the layout matching the group, layout ID, and
privacy.
|
static Layout |
updateName(long plid,
java.lang.String name,
java.lang.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,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.List<java.util.Locale> nameMapModifiedLocales)
Deprecated.
As of 6.2.0, with no direct replacement
|
static void |
updateScopedPortletNames(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String name,
java.lang.String languageId)
Deprecated.
As of 6.2.0, with no direct replacement
|
static MissingReferences |
validateImportLayoutsFile(long userId,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file) |
static MissingReferences |
validateImportLayoutsFile(long userId,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream inputStream) |
static MissingReferences |
validateImportPortletInfo(long userId,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file) |
static MissingReferences |
validateImportPortletInfo(long userId,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream inputStream) |
public static Layout addLayout(Layout layout) throws SystemException
layout - the layoutSystemException - if a system exception occurredpublic static Layout createLayout(long plid)
plid - the primary key for the new layoutpublic static Layout deleteLayout(long plid) throws PortalException, SystemException
plid - the primary key of the layoutPortalException - if a layout with the primary key could not be foundSystemException - if a system exception occurredpublic static Layout deleteLayout(Layout layout) throws SystemException
layout - the layoutSystemException - if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static java.util.List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery - the dynamic querySystemException - if a system exception occurredpublic static java.util.List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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)SystemException - if a system exception occurredpublic static java.util.List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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)SystemException - if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery - the dynamic querySystemException - if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQuery - the dynamic queryprojection - the projection to apply to the querySystemException - if a system exception occurredpublic static Layout fetchLayout(long plid) throws SystemException
SystemExceptionpublic static Layout fetchLayoutByUuidAndCompanyId(java.lang.String uuid, long companyId) throws SystemException
uuid - the layout's UUIDcompanyId - the primary key of the companynull if a matching layout could not be foundSystemException - if a system exception occurredpublic static Layout fetchLayoutByUuidAndGroupId(java.lang.String uuid, long groupId, boolean privateLayout) throws SystemException
uuid - the layout's UUIDgroupId - the primary key of the groupprivateLayout - whether the layout is private to the groupnull if a matching layout could not be foundSystemException - if a system exception occurredpublic static Layout getLayout(long plid) throws PortalException, SystemException
plid - the primary key of the layoutPortalException - if a layout with the primary key could not be foundSystemException - if a system exception occurredpublic static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static Layout getLayoutByUuidAndCompanyId(java.lang.String uuid, long companyId) throws PortalException, SystemException
uuid - the layout's UUIDcompanyId - the primary key of the companyPortalException - if a matching layout could not be foundSystemException - if a system exception occurredpublic static Layout getLayoutByUuidAndGroupId(java.lang.String uuid, long groupId, boolean privateLayout) throws PortalException, SystemException
uuid - the layout's UUIDgroupId - the primary key of the groupprivateLayout - whether the layout is private to the groupPortalException - if a matching layout could not be foundSystemException - if a system exception occurredpublic static java.util.List<Layout> getLayouts(int start, int end) throws SystemException
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)SystemException - if a system exception occurredpublic static int getLayoutsCount()
throws SystemException
SystemException - if a system exception occurredpublic static Layout updateLayout(Layout layout) throws SystemException
layout - the layoutSystemException - if a system exception occurredpublic static java.lang.String getBeanIdentifier()
public static void setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanpublic static Layout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Map<java.util.Locale,java.lang.String> keywordsMap, java.util.Map<java.util.Locale,java.lang.String> robotsMap, java.lang.String type, boolean hidden, java.lang.String friendlyURL, ServiceContext serviceContext) throws PortalException, SystemException
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 - if a group or user with the primary key could
not be found, if layout values were invalid, or if a portal
exception occurredSystemException - if a system exception occurredpublic static Layout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Map<java.util.Locale,java.lang.String> keywordsMap, java.util.Map<java.util.Locale,java.lang.String> robotsMap, java.lang.String type, java.lang.String typeSettings, boolean hidden, java.util.Map<java.util.Locale,java.lang.String> friendlyURLMap, ServiceContext serviceContext) throws PortalException, SystemException
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.PortalException - if a group or user with the primary key could not
be found, if layout values were invalid, or if a portal exception
occurredSystemException - if a system exception occurredpublic static Layout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL, ServiceContext serviceContext) throws PortalException, SystemException
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 - if a group or user with the primary key could not
be found, or if a portal exception occurredSystemException - if a system exception occurredpublic static void deleteLayout(Layout layout, boolean updateLayoutSet, ServiceContext serviceContext) throws PortalException, SystemException
layout - the layoutupdateLayoutSet - whether the layout set's page counter needs to be
updatedserviceContext - the service context to be appliedPortalException - if a portal exception occurredSystemException - if a system exception occurredpublic static void deleteLayout(long groupId,
boolean privateLayout,
long layoutId,
ServiceContext serviceContext)
throws PortalException,
SystemException
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 appliedPortalException - if a matching layout could not be found , or if
some other portal exception occurredSystemException - if a system exception occurredpublic static void deleteLayout(long plid,
ServiceContext serviceContext)
throws PortalException,
SystemException
plid - the primary key of the layoutserviceContext - the service context to be appliedPortalException - if a layout with the primary key could not be
found , or if some other portal exception occurredSystemException - if a system exception occurredpublic static void deleteLayouts(long groupId,
boolean privateLayout,
ServiceContext serviceContext)
throws PortalException,
SystemException
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 - if a group with the primary key could not be
found or if a layout set for the group and privacy could not be
foundSystemException - if a system exception occurredpublic static byte[] exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
throws PortalException,
SystemException
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 datePortalException - if a group or any layout with the primary key
could not be found, or if some other portal exception occurredSystemException - if a system exception occurredpublic static byte[] exportLayouts(long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
throws PortalException,
SystemException
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 datePortalException - if a group with the primary key could not be
found or if some other portal exception occurredSystemException - if a system exception occurredpublic static java.io.File exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
throws PortalException,
SystemException
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 datePortalException - if a group or any layout with the primary key
could not be found, or if some other portal exception occurredSystemException - if a system exception occurredpublic static long exportLayoutsAsFileInBackground(long userId,
java.lang.String taskName,
long groupId,
boolean privateLayout,
long[] layoutIds,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String fileName)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static byte[] exportPortletInfo(long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
throws PortalException,
SystemException
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 datePortalException - if a group or portlet with the primary key could
not be found, or if some other portal exception occurredSystemException - if a system exception occurredpublic static byte[] exportPortletInfo(long companyId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static java.io.File exportPortletInfoAsFile(long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
throws PortalException,
SystemException
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 datePortalException - if a group or portlet with the primary key could
not be found, or if some other portal exception occurredSystemException - if a system exception occurredpublic static java.io.File exportPortletInfoAsFile(long companyId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static long exportPortletInfoAsFileInBackground(long userId,
java.lang.String taskName,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String fileName)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static long exportPortletInfoAsFileInBackground(long userId,
java.lang.String taskName,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String fileName)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static Layout fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId) throws SystemException
SystemExceptionpublic static Layout fetchLayout(long groupId, boolean privateLayout, long layoutId) throws SystemException
SystemExceptionpublic static Layout fetchLayoutByFriendlyURL(long groupId, boolean privateLayout, java.lang.String friendlyURL) throws SystemException
SystemExceptionpublic static long getDefaultPlid(long groupId)
throws SystemException
groupId - the primary key of the groupLayoutConstants.DEFAULT_PLID)SystemException - if a system exception occurredpublic static long getDefaultPlid(long groupId,
boolean privateLayout)
throws SystemException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupLayoutConstants.DEFAULT_PLID) otherwiseSystemException - if a system exception occurredpublic static long getDefaultPlid(long groupId,
boolean privateLayout,
java.lang.String portletId)
throws PortalException,
SystemException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupportletId - the primary key of the portletLayoutConstants.DEFAULT_PLID
otherwisePortalException - if a portlet with the primary key could not be
foundSystemException - if a system exception occurredpublic static Layout getFriendlyURLLayout(long groupId, boolean privateLayout, java.lang.String friendlyURL) throws PortalException, SystemException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupfriendlyURL - the friendly URL of the layoutPortalException - if the friendly URL is null or a
matching layout could not be foundSystemException - if a system exception occurredpublic static Layout getLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException, SystemException
NoSuchLayoutException otherwise.groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutPortalException - if a matching layout could not be foundSystemException - if a system exception occurredpublic static Layout getLayoutByIconImageId(long iconImageId) throws PortalException, SystemException
NoSuchLayoutException otherwise.iconImageId - the primary key of the icon imagePortalException - if an icon image with the primary key could not
be foundSystemException - if a system exception occurredpublic static java.util.List<Layout> getLayouts(long groupId, boolean privateLayout) throws SystemException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupnull if no matches were
foundSystemException - if a system exception occurredpublic static java.util.List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId) throws SystemException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparentLayoutId - the primary key of the parent layoutnull if no matches were
foundSystemException - if a system exception occurredpublic static java.util.List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end) throws SystemException
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
foundSystemException - if a system exception occurredpublic static java.util.List<Layout> getLayouts(long groupId, boolean privateLayout, long[] layoutIds) throws PortalException, SystemException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutIds - the primary keys of the layoutsPortalException - if a group or layout with the primary key could
not be foundSystemException - if a system exception occurredpublic static java.util.List<Layout> getLayouts(long groupId, boolean privateLayout, java.lang.String type) throws SystemException
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
foundSystemException - if a system exception occurredpublic static LayoutReference[] getLayouts(long companyId, java.lang.String portletId, java.lang.String preferencesKey, java.lang.String preferencesValue) throws SystemException
companyId - the primary key of the companyportletId - the primary key of the portletpreferencesKey - the portlet's preference keypreferencesValue - the portlet's preference valueSystemException - if a system exception occurredpublic static java.util.List<Layout> getLayoutsByLayoutPrototypeUuid(java.lang.String layoutPrototypeUuid) throws SystemException
SystemExceptionpublic static int getLayoutsByLayoutPrototypeUuidCount(java.lang.String layoutPrototypeUuid)
throws SystemException
SystemExceptionpublic static int getLayoutsCount(Group group, boolean privateLayout) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static int getLayoutsCount(Group group, boolean privateLayout, boolean includeUserGroups) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static int getLayoutsCount(User user, boolean privateLayout) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static int getLayoutsCount(User user, boolean privateLayout, boolean includeUserGroups) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static long getNextLayoutId(long groupId,
boolean privateLayout)
throws SystemException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupSystemException - if a system exception occurredpublic static java.util.List<Layout> getNoPermissionLayouts(long roleId) throws SystemException
roleId - the primary key of the roleSystemException - if a system exception occurredpublic static java.util.List<Layout> getNullFriendlyURLLayouts() throws SystemException
nullnullSystemException - if a system exception occurredpublic static Layout getParentLayout(Layout layout) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static java.util.List<Layout> getScopeGroupLayouts(long groupId, boolean privateLayout) throws SystemException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupSystemException - if a system exception occurredpublic static boolean hasLayouts(Group group, boolean privateLayout) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static boolean hasLayouts(Group group, boolean privateLayout, boolean includeUserGroups) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static boolean hasLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
throws SystemException
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 layouttrue if the group has any layouts;
false otherwiseSystemException - if a system exception occurredpublic static boolean hasLayouts(User user, boolean privateLayout) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static boolean hasLayouts(User user, boolean privateLayout, boolean includeUserGroups) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static boolean hasLayoutSetPrototypeLayout(long layoutSetPrototypeId,
java.lang.String layoutUuid)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static boolean hasLayoutSetPrototypeLayout(java.lang.String layoutSetPrototypeUuid,
long companyId,
java.lang.String layoutUuid)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static void importLayouts(long userId,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
byte[] bytes)
throws PortalException,
SystemException
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 dataPortalException - if a group or user with the primary key could not
be found, or if some other portal exception occurredSystemException - if a system exception occurredLayoutImporterpublic static void importLayouts(long userId,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file)
throws PortalException,
SystemException
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 dataPortalException - if a group or user with the primary key could not
be found, or if some other portal exception occurredSystemException - if a system exception occurredLayoutImporterpublic static void importLayouts(long userId,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is)
throws PortalException,
SystemException
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 streamPortalException - if a group or user with the primary key could not
be found, or if some other portal exception occurredSystemException - if a system exception occurredLayoutImporterpublic static long importLayoutsInBackground(long userId,
java.lang.String taskName,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static long importLayoutsInBackground(long userId,
java.lang.String taskName,
long groupId,
boolean privateLayout,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static void importPortletInfo(long userId,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file)
throws PortalException,
SystemException
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 dataPortalException - if a group, layout, portlet or user with the
primary key could not be foundSystemException - if a system exception occurredpublic static void importPortletInfo(long userId,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is)
throws PortalException,
SystemException
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 streamPortalException - if a group, portlet, layout or user with the
primary key could not be foundSystemException - if a system exception occurredpublic static void importPortletInfo(long userId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static void importPortletInfo(long userId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static long importPortletInfoInBackground(long userId,
java.lang.String taskName,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static long importPortletInfoInBackground(long userId,
java.lang.String taskName,
long plid,
long groupId,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static long importPortletInfoInBackground(long userId,
java.lang.String taskName,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.File file)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static long importPortletInfoInBackground(long userId,
java.lang.String taskName,
java.lang.String portletId,
java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
java.io.InputStream is)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static void setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds,
ServiceContext serviceContext)
throws PortalException,
SystemException
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 appliedPortalException - 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 occurredSystemException - if a system exception occurredpublic static Layout updateFriendlyURL(long plid, java.lang.String friendlyURL, java.lang.String languageId) throws PortalException, SystemException
plid - the primary key of the layoutfriendlyURL - the friendly URL to be assignedlanguageId - the primary key of the languagePortalException - if a group or layout with the primary key could
not be foundSystemException - if a system exception occurredpublic static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Map<java.util.Locale,java.lang.String> keywordsMap, java.util.Map<java.util.Locale,java.lang.String> robotsMap, java.lang.String type, boolean hidden, java.util.Map<java.util.Locale,java.lang.String> friendlyURLMap, java.lang.Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext) throws PortalException, SystemException
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 - 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 occurredSystemException - if a system exception occurredpublic static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Map<java.util.Locale,java.lang.String> keywordsMap, java.util.Map<java.util.Locale,java.lang.String> robotsMap, java.lang.String type, boolean hidden, java.lang.String friendlyURL, java.lang.Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext) throws PortalException, SystemException
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 - 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 occurredSystemException - if a system exception occurredpublic static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, java.lang.String typeSettings) throws PortalException, SystemException
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).PortalException - if a matching layout could not be found or if a
portal exception occurredSystemException - if a system exception occurredpublic static Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, java.lang.String themeId, java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme) throws PortalException, SystemException
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 browsersPortalException - if a matching layout could not be foundSystemException - if a system exception occurredpublic static Layout updateName(Layout layout, java.lang.String name, java.lang.String languageId) throws PortalException, SystemException
layout - the layout to be updatedname - the layout's new namelanguageId - the primary key of the language. For more information
see Locale.PortalException - if the new name was nullSystemException - if a system exception occurredpublic static Layout updateName(long groupId, boolean privateLayout, long layoutId, java.lang.String name, java.lang.String languageId) throws PortalException, SystemException
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 - if a matching layout could not be found or if the
new name was nullSystemException - if a system exception occurredpublic static Layout updateName(long plid, java.lang.String name, java.lang.String languageId) throws PortalException, SystemException
plid - the primary key of the layoutname - the name to be assignedlanguageId - the primary key of the language. For more information
see Locale.PortalException - if a layout with the primary key could not be
found or if the name was nullSystemException - if a system exception occurredpublic static Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId) throws PortalException, SystemException
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
layoutPortalException - if a valid parent layout ID to use could not be
found or if a matching layout could not be foundSystemException - if a system exception occurredpublic static Layout updateParentLayoutId(long plid, long parentPlid) throws PortalException, SystemException
LayoutConstants.DEFAULT_PARENT_LAYOUT_ID is
assigned.plid - the primary key of the layoutparentPlid - the primary key of the parent layoutPortalException - if a layout with the primary key could not be
found or if a valid parent layout ID to use could not be foundSystemException - if a system exception occurredpublic static Layout updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static void updatePriorities(long groupId,
boolean privateLayout)
throws PortalException,
SystemException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupPortalException - if a matching layout could not be foundSystemException - if a system exception occurredpublic static Layout updatePriority(Layout layout, int priority) throws PortalException, SystemException
layout - the layout to be updatedpriority - the layout's new priorityPortalException - if a portal exception occurredSystemException - if a system exception occurredpublic static Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority) throws PortalException, SystemException
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 priorityPortalException - if a matching layout could not be foundSystemException - if a system exception occurredpublic static Layout updatePriority(long groupId, boolean privateLayout, long layoutId, long nextLayoutId, long previousLayoutId) throws PortalException, SystemException
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 layoutPortalException - if a matching layout could not be foundSystemException - if a system exception occurredpublic static Layout updatePriority(long plid, int priority) throws PortalException, SystemException
plid - the primary key of the layoutpriority - the layout's new priorityPortalException - if a layout with the primary key could not be
foundSystemException - if a system exception occurredpublic static void updateScopedPortletNames(long groupId,
boolean privateLayout,
long layoutId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.List<java.util.Locale> nameMapModifiedLocales)
throws PortalException,
SystemException
PortalExceptionSystemExceptionpublic static void updateScopedPortletNames(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String name,
java.lang.String languageId)
throws PortalException,
SystemException
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 languagePortalException - if a matching layout could not be foundSystemException - if a system exception occurredcom.liferay.portlet.portletconfiguration.action.EditScopeActionpublic static MissingReferences validateImportLayoutsFile(long userId, long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.File file) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static MissingReferences validateImportLayoutsFile(long userId, long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.InputStream inputStream) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static MissingReferences validateImportPortletInfo(long userId, long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.File file) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static MissingReferences validateImportPortletInfo(long userId, long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.InputStream inputStream) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static LayoutLocalService getService()
public void setService(LayoutLocalService service)