|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ProviderType @AccessControlled @JSONWebService @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface LayoutService
Provides the remote service interface for Layout. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
LayoutServiceUtil
,
LayoutServiceBaseImpl
,
com.liferay.portal.service.impl.LayoutServiceImpl
Method Summary | |
---|---|
Layout |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
Map<Locale,String> localeNamesMap,
Map<Locale,String> localeTitlesMap,
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, boolean,
long, Map, Map, Map, Map, Map, String, String, boolean, Map,
ServiceContext) |
Layout |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
Map<Locale,String> localeNamesMap,
Map<Locale,String> localeTitlesMap,
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 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. |
FileEntry |
addTempFileEntry(long groupId,
String fileName,
String tempFolderName,
InputStream inputStream,
String mimeType)
|
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 |
deleteTempFileEntry(long groupId,
String fileName,
String tempFolderName)
|
byte[] |
exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Exports the layouts that match the primary keys and the 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 all layouts that match the primary keys and criteria as a file. |
long |
exportLayoutsAsFileInBackground(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(String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
long |
exportPortletInfoAsFileInBackground(String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
|
long |
exportPortletInfoAsFileInBackground(String taskName,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
|
List<Layout> |
getAncestorLayouts(long plid)
Returns all the ancestor layouts of the layout. |
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
long |
getDefaultPlid(long groupId,
long scopeGroupId,
boolean privateLayout,
String portletId)
Returns the primary key of the default layout for the group. |
long |
getDefaultPlid(long groupId,
long scopeGroupId,
String portletId)
|
Layout |
getLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
Returns the layout matching the UUID, group, and privacy. |
String |
getLayoutName(long groupId,
boolean privateLayout,
long layoutId,
String languageId)
Returns the name of the layout. |
LayoutReference[] |
getLayoutReferences(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> |
getLayouts(long groupId,
boolean privateLayout)
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
boolean incomplete,
int start,
int end)
|
int |
getLayoutsCount(long groupId,
boolean privateLayout,
long parentLayoutId)
|
String[] |
getTempFileEntryNames(long groupId,
String tempFolderName)
|
void |
importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
byte[] bytes)
Imports the layouts from the byte array. |
void |
importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
Imports the layouts from the file. |
void |
importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
Imports the layouts from the input stream. |
long |
importLayoutsInBackground(String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
|
long |
importLayoutsInBackground(String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream inputStream)
|
void |
importPortletInfo(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 plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
Imports the portlet information (categories, permissions, ... etc.) from the input stream. |
void |
importPortletInfo(String portletId,
Map<String,String[]> parameterMap,
File file)
|
void |
importPortletInfo(String portletId,
Map<String,String[]> parameterMap,
InputStream is)
|
long |
importPortletInfoInBackground(String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
|
long |
importPortletInfoInBackground(String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
|
void |
importPortletInfoInBackground(String taskName,
String portletId,
Map<String,String[]> parameterMap,
File file)
|
void |
importPortletInfoInBackground(String taskName,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
|
void |
schedulePublishToLive(long sourceGroupId,
long targetGroupId,
boolean privateLayout,
Map<Long,Boolean> layoutIdMap,
Map<String,String[]> parameterMap,
String scope,
Date startDate,
Date endDate,
String groupName,
String cronText,
Date schedulerStartDate,
Date schedulerEndDate,
String description)
Schedules a range of layouts to be published. |
void |
schedulePublishToRemote(long sourceGroupId,
boolean privateLayout,
Map<Long,Boolean> layoutIdMap,
Map<String,String[]> parameterMap,
String remoteAddress,
int remotePort,
String remotePathContext,
boolean secureConnection,
long remoteGroupId,
boolean remotePrivateLayout,
Date startDate,
Date endDate,
String groupName,
String cronText,
Date schedulerStartDate,
Date schedulerEndDate,
String description)
Schedules a range of layouts to be stored. |
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds,
ServiceContext serviceContext)
Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout. |
void |
unschedulePublishToLive(long groupId,
String jobName,
String groupName)
Deletes the job from the scheduler's queue. |
void |
unschedulePublishToRemote(long groupId,
String jobName,
String groupName)
Deletes the job from the scheduler's persistent queue. |
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId,
Map<Locale,String> localeNamesMap,
Map<Locale,String> localeTitlesMap,
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 with additional parameters. |
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId,
Map<Locale,String> localeNamesMap,
Map<Locale,String> localeTitlesMap,
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(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)
|
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. |
MissingReferences |
validateImportLayoutsFile(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
|
MissingReferences |
validateImportLayoutsFile(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream inputStream)
|
MissingReferences |
validateImportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
|
MissingReferences |
validateImportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream inputStream)
|
Method Detail |
---|
String getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanLayout addLayout(long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, 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, 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.
groupId
- 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
)localeNamesMap
- the layout's locales and localized nameslocaleTitlesMap
- 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 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 used to
specify whether site administrators can modify this page
within their site.
PortalException
- if a group with the primary key could not be
found, if the group did not have permission to manage the
layouts involved, if layout values were invalid, or if a
portal exception occurred
SystemException
- if a system exception occurredLayout addLayout(long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, 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.
groupId
- 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
)localeNamesMap
- the layout's locales and localized nameslocaleTitlesMap
- 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 used to specify whether site
administrators can modify this page within their site.
PortalException
- if a group with the primary key could not be
found, if the group did not have permission to manage the layouts
involved, if layout values were invalid, or if a portal exception
occurred
SystemException
- if a system exception occurredLayout addLayout(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.
groupId
- 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
)name
- Map the layout's locales and localized namestitle
- Map the layout's locales and localized titlesdescription
- Map the layout's locales and localized descriptionstype
- 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 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 specify 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 used to specify whether site
administrators can modify this page within their site.
PortalException
- if a group with the primary key could not be
found, if the group did not have permission to manage the layouts
involved, if layout values were invalid, or if a portal exception
occurred
SystemException
- if a system exception occurredFileEntry addTempFileEntry(long groupId, String fileName, String tempFolderName, InputStream inputStream, String mimeType) throws PortalException, SystemException
PortalException
SystemException
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 applied
PortalException
- if the user did not have permission to delete the
layout, 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 the user did not have permission to delete the
layout, if a layout with the primary key could not be found , or
if some other portal exception occurred
SystemException
- if a system exception occurredvoid deleteTempFileEntry(long groupId, String fileName, String tempFolderName) throws PortalException, SystemException
PortalException
SystemException
byte[] 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, if the group did not have permission to
manage the layouts, 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, if the group did not have permission to manage the
layouts, 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, it the group did not have permission to
manage the layouts, or if some other portal exception occurred
SystemException
- if a system exception occurredlong exportLayoutsAsFileInBackground(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 layout, group, or portlet with the primary
key could not be found, if the group did not have permission to
manage the layouts involved, 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 layout, group, or portlet with the primary
key could not be found, it the group did not have permission to
manage the layouts involved, or if some other portal exception
occurred
SystemException
- if a system exception occurredFile exportPortletInfoAsFile(String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
long exportPortletInfoAsFileInBackground(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(String taskName, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getAncestorLayouts(long plid) throws PortalException, SystemException
plid
- the primary key of the layout
PortalException
- if a matching layout could not be found or if a
portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) long getDefaultPlid(long groupId, long scopeGroupId, boolean privateLayout, String portletId) throws PortalException, SystemException
groupId
- the primary key of the groupscopeGroupId
- the primary key of the scope group. See ServiceContext.getScopeGroupId()
.privateLayout
- whether the layout is private to the groupportletId
- the primary key of the portlet
LayoutConstants.DEFAULT_PLID
otherwise
PortalException
- if a group, layout, or portlet with the primary
key could not be found
SystemException
- if a system exception occurred@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) long getDefaultPlid(long groupId, long scopeGroupId, String portletId) throws PortalException, SystemException
PortalException
SystemException
@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, if the
user did not have permission to view the layout, or if some other
portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) String getLayoutName(long groupId, boolean privateLayout, long layoutId, 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 layoutlanguageId
- the primary key of the language. For more information
See Locale
.
PortalException
- if a matching layout could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) LayoutReference[] getLayoutReferences(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> getLayouts(long groupId, boolean privateLayout) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) String[] getTempFileEntryNames(long groupId, String tempFolderName) throws PortalException, SystemException
PortalException
SystemException
void importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes) 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 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 with the primary key could not be
found, if the group did not have permission to manage the
layouts, or if some other portal exception occurred
SystemException
- if a system exception occurredLayoutImporter
void importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file) 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 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 with the primary key could not be
found, if the group did not have permission to manage the layouts
and publish, or if some other portal exception occurred
SystemException
- if a system exception occurredLayoutImporter
void importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is) 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 will be imported. For information on the keys used in
the map see PortletDataHandlerKeys
.is
- the input stream
PortalException
- if a group with the primary key could not be
found, if the group did not have permission to manage the
layouts, or if some other portal exception occurred
SystemException
- if a system exception occurredLayoutImporter
long importLayoutsInBackground(String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
long importLayoutsInBackground(String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream inputStream) throws PortalException, SystemException
PortalException
SystemException
void importPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file) 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 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, or portlet with the primary
key could not be found, or if the group did not have permission
to manage the layouts
SystemException
- if a system exception occurredvoid importPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is) 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 will be imported. For information on the keys used in
the map see PortletDataHandlerKeys
.is
- the input stream
PortalException
- if a group, portlet, or layout with the primary
key could not be found or if the group did not have permission to
manage the layouts
SystemException
- if a system exception occurredvoid importPortletInfo(String portletId, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
void importPortletInfo(String portletId, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
long importPortletInfoInBackground(String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
long importPortletInfoInBackground(String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
void importPortletInfoInBackground(String taskName, String portletId, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
void importPortletInfoInBackground(String taskName, String portletId, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
void schedulePublishToLive(long sourceGroupId, long targetGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String scope, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description) throws PortalException, SystemException
sourceGroupId
- the primary key of the source grouptargetGroupId
- the primary key of the target groupprivateLayout
- whether the layout is private to the grouplayoutIdMap
- the layouts considered for publishing, specified by
the layout IDs and booleans indicating whether they have childrenparameterMap
- the mapping of parameters indicating which
information will be used. See PortletDataHandlerKeys
scope
- the scope of the pages. It can be all-pages
or
selected-pages
.startDate
- the start dateendDate
- the end dategroupName
- the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER
).
See DestinationNames
.cronText
- the cron text. See #toCronText
schedulerStartDate
- the scheduler start dateschedulerEndDate
- the scheduler end datedescription
- the scheduler description
PortalException
- if the group did not have permission to manage
and publish
SystemException
- if a system exception occurredvoid schedulePublishToRemote(long sourceGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description) throws PortalException, SystemException
sourceGroupId
- the primary key of the source groupprivateLayout
- whether the layout is private to the grouplayoutIdMap
- the layouts considered for publishing, specified by
the layout IDs and booleans indicating whether they have childrenparameterMap
- the mapping of parameters indicating which
information will be used. See PortletDataHandlerKeys
remoteAddress
- the remote addressremotePort
- the remote portremotePathContext
- the remote path contextsecureConnection
- whether the connection is secureremoteGroupId
- the primary key of the remote groupremotePrivateLayout
- whether remote group's layout is privatestartDate
- the start dateendDate
- the end dategroupName
- the group name. Optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER
).
See DestinationNames
.cronText
- the cron text. See #toCronText
schedulerStartDate
- the scheduler start dateschedulerEndDate
- the scheduler end datedescription
- the scheduler description
PortalException
- if a group with the source group primary key was
not found or if the group did not have permission to publish
SystemException
- if a system exception occurredvoid 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 the group did not have permission to manage the
layouts, 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 occurredvoid unschedulePublishToLive(long groupId, String jobName, String groupName) throws PortalException, SystemException
groupId
- the primary key of the groupjobName
- the job namegroupName
- the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER
).
See DestinationNames
.
PortalException
- if the group did not permission to manage staging
and publish
SystemException
- if a system exception occurredvoid unschedulePublishToRemote(long groupId, String jobName, String groupName) throws PortalException, SystemException
groupId
- the primary key of the groupjobName
- the job namegroupName
- the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER
).
See DestinationNames
.
PortalException
- if a group with the primary key could not be
found or if the group did not have permission to publish
SystemException
- if a system exception occurredLayout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, 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 layoutlocaleNamesMap
- the layout's locales and localized nameslocaleTitlesMap
- the layout's locales and localized titlesdescriptionMap
- 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.
PortalException
- if a group or layout with the primary key could
not be found, if the user did not have permission to update the
layout, if a unique friendly URL could not be generated, if a
valid parent layout ID to use could not be found, or if the
layout parameters were invalid
SystemException
- if a system exception occurredLayout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, 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
layoutlocaleNamesMap
- the layout's locales and localized nameslocaleTitlesMap
- the layout's locales and localized titlesdescriptionMap
- 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 locales and new 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.
PortalException
- if a group or layout with the primary key
could not be found, if the user did not have permission to
update the layout, if a unique friendly URL could not be
generated, if a valid parent layout ID to use could not be
found, or if the layout parameters were invalid
SystemException
- if a system exception 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 the
user did not have permission to update the layout
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, or if
the user did not have permission to update the layout and
permission to apply the theme
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, if the
user did not have permission to update the layout, 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 user did not have permission to update the
layout, 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, if a matching layout could not be found, or if the user
did not have permission to update the layout
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, if the user did not have permission to update the layout,
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
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 priority
PortalException
- if a matching layout could not be found or if the
user did not have permission to update the layout
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 or if the
user did not have permission to update the layout
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 occurredMissingReferences validateImportLayoutsFile(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
MissingReferences validateImportLayoutsFile(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream inputStream) throws PortalException, SystemException
PortalException
SystemException
MissingReferences validateImportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
MissingReferences validateImportPortletInfo(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 |