|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface LayoutLocalService
Provides the local service interface for Layout. 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.
LayoutLocalServiceUtil
,
LayoutLocalServiceBaseImpl
,
com.liferay.portal.service.impl.LayoutLocalServiceImpl
Method Summary | |
---|---|
Layout |
addLayout(Layout layout)
Adds the layout to the database. |
Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
Map<Locale,String> nameMap,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
Map<Locale,String> keywordsMap,
Map<Locale,String> robotsMap,
String type,
boolean hidden,
String friendlyURL,
ServiceContext serviceContext)
Deprecated. As of 6.2.0, replaced by addLayout(long, long,
boolean, long, Map, Map, Map, Map, Map, String, String,
boolean, Map, ServiceContext) |
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. |
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. |
Layout |
createLayout(long plid)
Creates a new layout with the primary key. |
Layout |
deleteLayout(Layout layout)
Deletes the layout from the database. |
void |
deleteLayout(Layout layout,
boolean updateLayoutSet,
ServiceContext serviceContext)
Deletes the layout, its child layouts, and its associated resources. |
Layout |
deleteLayout(long plid)
Deletes the layout with the primary key from the database. |
void |
deleteLayout(long groupId,
boolean privateLayout,
long layoutId,
ServiceContext serviceContext)
Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources. |
void |
deleteLayout(long plid,
ServiceContext serviceContext)
Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources. |
void |
deleteLayouts(long groupId,
boolean privateLayout,
ServiceContext serviceContext)
Deletes the group's private or non-private layouts, also deleting the layouts' child layouts, and associated resources. |
DynamicQuery |
dynamicQuery()
|
List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query. |
byte[] |
exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Exports layouts with the primary keys and criteria as a byte array. |
byte[] |
exportLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Exports all layouts that match the criteria as a byte array. |
File |
exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Exports the layouts that match the primary keys and criteria as a file. |
long |
exportLayoutsAsFileInBackground(long userId,
String taskName,
long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
|
byte[] |
exportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Exports the portlet information (categories, permissions, ... etc.) as a byte array. |
byte[] |
exportPortletInfo(long companyId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
File |
exportPortletInfoAsFile(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Exports the portlet information (categories, permissions, ... etc.) as a file. |
File |
exportPortletInfoAsFile(long companyId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
long |
exportPortletInfoAsFileInBackground(long userId,
String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
|
long |
exportPortletInfoAsFileInBackground(long userId,
String taskName,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
|
Layout |
fetchFirstLayout(long groupId,
boolean privateLayout,
long parentLayoutId)
|
Layout |
fetchLayout(long plid)
|
Layout |
fetchLayout(long groupId,
boolean privateLayout,
long layoutId)
|
Layout |
fetchLayoutByFriendlyURL(long groupId,
boolean privateLayout,
String friendlyURL)
|
Layout |
fetchLayoutByUuidAndCompanyId(String uuid,
long companyId)
Returns the layout with the matching UUID and company. |
Layout |
fetchLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
Returns the layout matching the UUID, group, and privacy. |
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
long |
getDefaultPlid(long groupId)
Returns the primary key of the default layout for the group |
long |
getDefaultPlid(long groupId,
boolean privateLayout)
Returns primary key of the matching default layout for the group |
long |
getDefaultPlid(long groupId,
boolean privateLayout,
String portletId)
Returns primary key of the default portlet layout for the group |
Layout |
getFriendlyURLLayout(long groupId,
boolean privateLayout,
String friendlyURL)
Returns the layout for the friendly URL |
Layout |
getLayout(long plid)
Returns the layout with the primary key. |
Layout |
getLayout(long groupId,
boolean privateLayout,
long layoutId)
Returns the layout matching the primary key, group, and privacy; throws a NoSuchLayoutException otherwise. |
Layout |
getLayoutByIconImageId(long iconImageId)
Returns the layout for the icon image; throws a NoSuchLayoutException otherwise. |
Layout |
getLayoutByUuidAndCompanyId(String uuid,
long companyId)
Returns the layout with the matching UUID and company. |
Layout |
getLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
Returns the layout matching the UUID, group, and privacy. |
List<Layout> |
getLayouts(int start,
int end)
Returns a range of all the layouts. |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout)
Returns all the layouts belonging to the group. |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
Returns all the layouts belonging to the group that are children of the parent layout. |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long[] layoutIds)
Returns all the layouts that match the layout IDs and belong to the group. |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
boolean incomplete,
int start,
int end)
Returns a range of all the layouts belonging to the group that are children of the parent layout. |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String type)
Returns all the layouts that match the type and belong to the group. |
LayoutReference[] |
getLayouts(long companyId,
String portletId,
String preferencesKey,
String preferencesValue)
Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences. |
List<Layout> |
getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid)
|
int |
getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid)
|
int |
getLayoutsCount()
Returns the number of layouts. |
int |
getLayoutsCount(Group group,
boolean privateLayout)
|
int |
getLayoutsCount(Group group,
boolean privateLayout,
boolean includeUserGroups)
|
int |
getLayoutsCount(User user,
boolean privateLayout)
|
int |
getLayoutsCount(User user,
boolean privateLayout,
boolean includeUserGroups)
|
long |
getNextLayoutId(long groupId,
boolean privateLayout)
Returns the primary key to use for the next layout. |
List<Layout> |
getNoPermissionLayouts(long roleId)
Returns all the layouts without resource permissions |
List<Layout> |
getNullFriendlyURLLayouts()
Returns all the layouts whose friendly URLs are null |
Layout |
getParentLayout(Layout layout)
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
List<Layout> |
getScopeGroupLayouts(long groupId,
boolean privateLayout)
Returns all the layouts within scope of the group |
boolean |
hasLayouts(Group group,
boolean privateLayout)
|
boolean |
hasLayouts(Group group,
boolean privateLayout,
boolean includeUserGroups)
|
boolean |
hasLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
Returns true if the group has any layouts;
false otherwise. |
boolean |
hasLayouts(User user,
boolean privateLayout)
|
boolean |
hasLayouts(User user,
boolean privateLayout,
boolean includeUserGroups)
|
boolean |
hasLayoutSetPrototypeLayout(long layoutSetPrototypeId,
String layoutUuid)
|
boolean |
hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid,
long companyId,
String layoutUuid)
|
void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
byte[] bytes)
Imports the layouts from the byte array. |
void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
Imports the layouts from the file. |
void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
Imports the layouts from the input stream. |
long |
importLayoutsInBackground(long userId,
String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
|
long |
importLayoutsInBackground(long userId,
String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
|
void |
importPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
Imports the portlet information (categories, permissions, ... etc.) from the file. |
void |
importPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
Imports the portlet information (categories, permissions, ... etc.) from the input stream. |
void |
importPortletInfo(long userId,
String portletId,
Map<String,String[]> parameterMap,
File file)
|
void |
importPortletInfo(long userId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
|
long |
importPortletInfoInBackground(long userId,
String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
|
long |
importPortletInfoInBackground(long userId,
String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
|
long |
importPortletInfoInBackground(long userId,
String taskName,
String portletId,
Map<String,String[]> parameterMap,
File file)
|
long |
importPortletInfoInBackground(long userId,
String taskName,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
|
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds,
ServiceContext serviceContext)
Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout. |
Layout |
updateFriendlyURL(long plid,
String friendlyURL,
String languageId)
Updates the friendly URL of the layout. |
Layout |
updateLayout(Layout layout)
Updates the layout in the database or adds it if it does not yet exist. |
Layout |
updateLayout(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. |
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) |
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings)
Updates the layout replacing its type settings. |
Layout |
updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
String themeId,
String colorSchemeId,
String css,
boolean wapTheme)
Updates the look and feel of the layout. |
Layout |
updateName(Layout layout,
String name,
String languageId)
Updates the name of the layout. |
Layout |
updateName(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
Updates the name of the layout matching the group, layout ID, and privacy. |
Layout |
updateName(long plid,
String name,
String languageId)
Updates the name of the layout matching the primary key. |
Layout |
updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
Updates the parent layout ID of the layout matching the group, layout ID, and privacy. |
Layout |
updateParentLayoutId(long plid,
long parentPlid)
Updates the parent layout ID of the layout matching the primary key. |
Layout |
updateParentLayoutIdAndPriority(long plid,
long parentPlid,
int priority)
|
void |
updatePriorities(long groupId,
boolean privateLayout)
Updates the priorities of the layouts. |
Layout |
updatePriority(Layout layout,
int priority)
Updates the priority of the layout. |
Layout |
updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
Updates the priority of the layout matching the group, layout ID, and privacy. |
Layout |
updatePriority(long 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. |
Layout |
updatePriority(long plid,
int priority)
Updates the priority of the layout matching the primary key. |
void |
updateScopedPortletNames(long groupId,
boolean privateLayout,
long layoutId,
Map<Locale,String> nameMap,
List<Locale> nameMapModifiedLocales)
Deprecated. As of 6.2.0, with no direct replacement |
void |
updateScopedPortletNames(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
Deprecated. As of 6.2.0, with no direct replacement |
MissingReferences |
validateImportLayoutsFile(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
|
MissingReferences |
validateImportLayoutsFile(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream inputStream)
|
MissingReferences |
validateImportPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
|
MissingReferences |
validateImportPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream inputStream)
|
Method Detail |
---|
@Indexable(type=REINDEX) Layout addLayout(Layout layout) throws SystemException
layout
- the layout
SystemException
- if a system exception occurredLayout createLayout(long plid)
plid
- the primary key for the new layout
@Indexable(type=DELETE) Layout deleteLayout(long plid) throws PortalException, SystemException
plid
- the primary key of the layout
PortalException
- if a layout with the primary key could not be found
SystemException
- if a system exception occurred@Indexable(type=DELETE) Layout deleteLayout(Layout layout) throws SystemException
layout
- the layout
SystemException
- if a system exception occurredDynamicQuery dynamicQuery()
List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredList 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 occurredList 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 occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Layout fetchLayout(long plid) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Layout fetchLayoutByUuidAndCompanyId(String uuid, long companyId) throws SystemException
uuid
- the layout's UUIDcompanyId
- the primary key of the company
null
if a matching layout could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Layout fetchLayoutByUuidAndGroupId(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 group
null
if a matching layout could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Layout getLayout(long plid) throws PortalException, SystemException
plid
- the primary key of the layout
PortalException
- if a layout with the primary key could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
getPersistedModel
in interface PersistedModelLocalService
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Layout getLayoutByUuidAndCompanyId(String uuid, long companyId) throws PortalException, SystemException
uuid
- the layout's UUIDcompanyId
- the primary key of the company
PortalException
- if a matching layout could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Layout getLayoutByUuidAndGroupId(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 group
PortalException
- if a matching layout could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutsCount() throws SystemException
SystemException
- if a system exception occurred@Indexable(type=REINDEX) Layout updateLayout(Layout layout) throws SystemException
layout
- the layout
SystemException
- if a system exception occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanLayout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> nameMap, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext) throws PortalException, SystemException
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 occurred
SystemException
- if a system exception occurredLayout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> nameMap, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, String typeSettings, boolean hidden, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext) throws PortalException, SystemException
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
occurred
SystemException
- if a system exception occurredLayout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext) throws PortalException, SystemException
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 PropsValues
title
- 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 occurred
SystemException
- if a system exception occurred@SystemEvent(action=1, type=1) 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 applied
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredvoid 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 applied
PortalException
- if a matching layout could not be found , or if
some other portal exception occurred
SystemException
- if a system exception occurredvoid deleteLayout(long plid, ServiceContext serviceContext) throws PortalException, SystemException
plid
- the primary key of the layoutserviceContext
- the service context to be applied
PortalException
- if a layout with the primary key could not be
found , or if some other portal exception occurred
SystemException
- if a system exception occurredvoid 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
found
SystemException
- if a system exception occurredbyte[] exportLayouts(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, 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 date
PortalException
- if a group or any layout with the primary key
could not be found, or if some other portal exception occurred
SystemException
- if a system exception occurredbyte[] exportLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, Date startDate, 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 date
PortalException
- if a group with the primary key could not be
found or if some other portal exception occurred
SystemException
- if a system exception occurredFile exportLayoutsAsFile(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, 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 date
PortalException
- if a group or any layout with the primary key
could not be found, or if some other portal exception occurred
SystemException
- if a system exception occurredlong exportLayoutsAsFileInBackground(long userId, String taskName, long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName) throws PortalException, SystemException
PortalException
SystemException
byte[] exportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, 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 date
PortalException
- if a group or portlet with the primary key could
not be found, or if some other portal exception occurred
SystemException
- if a system exception occurredbyte[] exportPortletInfo(long companyId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
File exportPortletInfoAsFile(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, 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 date
PortalException
- if a group or portlet with the primary key could
not be found, or if some other portal exception occurred
SystemException
- if a system exception occurredFile exportPortletInfoAsFile(long companyId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
long exportPortletInfoAsFileInBackground(long userId, String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName) throws PortalException, SystemException
PortalException
SystemException
long exportPortletInfoAsFileInBackground(long userId, String taskName, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Layout fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Layout fetchLayout(long groupId, boolean privateLayout, long layoutId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Layout fetchLayoutByFriendlyURL(long groupId, boolean privateLayout, String friendlyURL) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) long getDefaultPlid(long groupId) throws SystemException
groupId
- the primary key of the group
LayoutConstants.DEFAULT_PLID
)
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) long getDefaultPlid(long groupId, boolean privateLayout) throws SystemException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group
LayoutConstants.DEFAULT_PLID
) otherwise
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) long getDefaultPlid(long groupId, boolean privateLayout, 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 portlet
LayoutConstants.DEFAULT_PLID
otherwise
PortalException
- if a portlet with the primary key could not be
found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Layout getFriendlyURLLayout(long groupId, boolean privateLayout, 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 layout
PortalException
- if the friendly URL is null
or a
matching layout could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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 layout
PortalException
- if a matching layout could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Layout getLayoutByIconImageId(long iconImageId) throws PortalException, SystemException
NoSuchLayoutException
otherwise.
iconImageId
- the primary key of the icon image
PortalException
- if an icon image with the primary key could not
be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayouts(long groupId, boolean privateLayout) throws SystemException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group
null
if no matches were
found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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 layout
null
if no matches were
found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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
found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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 layouts
PortalException
- if a group or layout with the primary key could
not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayouts(long groupId, boolean privateLayout, 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
found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) LayoutReference[] getLayouts(long companyId, String portletId, String preferencesKey, 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 value
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutsCount(Group group, boolean privateLayout) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutsCount(Group group, boolean privateLayout, boolean includeUserGroups) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutsCount(User user, boolean privateLayout) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutsCount(User user, boolean privateLayout, boolean includeUserGroups) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) long getNextLayoutId(long groupId, boolean privateLayout) throws SystemException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getNoPermissionLayouts(long roleId) throws SystemException
roleId
- the primary key of the role
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getNullFriendlyURLLayouts() throws SystemException
null
null
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Layout getParentLayout(Layout layout) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getScopeGroupLayouts(long groupId, boolean privateLayout) throws SystemException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasLayouts(Group group, boolean privateLayout) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasLayouts(Group group, boolean privateLayout, boolean includeUserGroups) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) 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 layout
true
if the group has any layouts;
false
otherwise
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasLayouts(User user, boolean privateLayout) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasLayouts(User user, boolean privateLayout, boolean includeUserGroups) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasLayoutSetPrototypeLayout(long layoutSetPrototypeId, String layoutUuid) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid, long companyId, String layoutUuid) throws PortalException, SystemException
PortalException
SystemException
void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,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 data
PortalException
- if a group or user with the primary key could not
be found, or if some other portal exception occurred
SystemException
- if a system exception occurredLayoutImporter
void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, 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 data
PortalException
- if a group or user with the primary key could not
be found, or if some other portal exception occurred
SystemException
- if a system exception occurredLayoutImporter
void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, 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 stream
PortalException
- if a group or user with the primary key could not
be found, or if some other portal exception occurred
SystemException
- if a system exception occurredLayoutImporter
long importLayoutsInBackground(long userId, String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
long importLayoutsInBackground(long userId, String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
void importPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, 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 data
PortalException
- if a group, layout, portlet or user with the
primary key could not be found
SystemException
- if a system exception occurredvoid importPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, 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 stream
PortalException
- if a group, portlet, layout or user with the
primary key could not be found
SystemException
- if a system exception occurredvoid importPortletInfo(long userId, String portletId, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
void importPortletInfo(long userId, String portletId, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
long importPortletInfoInBackground(long userId, String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
long importPortletInfoInBackground(long userId, String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
long importPortletInfoInBackground(long userId, String taskName, String portletId, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
long importPortletInfoInBackground(long userId, String taskName, String portletId, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
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 applied
PortalException
- if a group or layout with the primary key could
not be found, if no layouts were specified, if the first layout
was not page-able, if the first layout was hidden, or if some
other portal exception occurred
SystemException
- if a system exception occurredLayout updateFriendlyURL(long plid, String friendlyURL, String languageId) throws PortalException, SystemException
plid
- the primary key of the layoutfriendlyURL
- the friendly URL to be assignedlanguageId
- the primary key of the language
PortalException
- if a group or layout with the primary key could
not be found
SystemException
- if a system exception occurredLayout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> nameMap, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, boolean hidden, Map<Locale,String> friendlyURLMap, Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext) throws PortalException, SystemException
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 occurred
SystemException
- if a system exception occurredLayout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> nameMap, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, boolean hidden, String friendlyURL, Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext) throws PortalException, SystemException
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 occurred
SystemException
- if a system exception occurredLayout updateLayout(long groupId, boolean privateLayout, long layoutId, 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 occurred
SystemException
- if a system exception occurredLayout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, 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 browsers
PortalException
- if a matching layout could not be found
SystemException
- if a system exception occurredLayout updateName(Layout layout, String name, 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 null
SystemException
- if a system exception occurredLayout updateName(long groupId, boolean privateLayout, long layoutId, String name, 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 null
SystemException
- if a system exception occurredLayout updateName(long plid, String name, 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 null
SystemException
- if a system exception occurredLayout 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
layout
PortalException
- if a valid parent layout ID to use could not be
found or if a matching layout could not be found
SystemException
- if a system exception occurredLayout 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 layout
PortalException
- if a layout with the primary key could not be
found or if a valid parent layout ID to use could not be found
SystemException
- if a system exception occurredLayout updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority) throws PortalException, SystemException
PortalException
SystemException
void updatePriorities(long groupId, boolean privateLayout) throws PortalException, SystemException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group
PortalException
- if a matching layout could not be found
SystemException
- if a system exception occurredLayout updatePriority(Layout layout, int priority) throws PortalException, SystemException
layout
- the layout to be updatedpriority
- the layout's new priority
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredLayout 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 priority
PortalException
- if a matching layout could not be found
SystemException
- if a system exception occurredLayout 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 layout
PortalException
- if a matching layout could not be found
SystemException
- if a system exception occurredLayout updatePriority(long plid, int priority) throws PortalException, SystemException
plid
- the primary key of the layoutpriority
- the layout's new priority
PortalException
- if a layout with the primary key could not be
found
SystemException
- if a system exception occurredvoid updateScopedPortletNames(long groupId, boolean privateLayout, long layoutId, Map<Locale,String> nameMap, List<Locale> nameMapModifiedLocales) throws PortalException, SystemException
PortalException
SystemException
void updateScopedPortletNames(long groupId, boolean privateLayout, long layoutId, String name, 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 language
PortalException
- if a matching layout could not be found
SystemException
- if a system exception occurredcom.liferay.portlet.portletconfiguration.action.EditScopeAction
MissingReferences validateImportLayoutsFile(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
MissingReferences validateImportLayoutsFile(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream inputStream) throws PortalException, SystemException
PortalException
SystemException
MissingReferences validateImportPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
MissingReferences validateImportPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream inputStream) throws PortalException, SystemException
PortalException
SystemException
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |