|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BaseServiceImpl
com.liferay.portal.service.base.LayoutServiceBaseImpl
com.liferay.portal.service.impl.LayoutServiceImpl
public class LayoutServiceImpl
Provides the remote service for accessing, adding, deleting, exporting, importing, scheduling publishing of, and updating layouts. Its methods include permission checks.
| Field Summary |
|---|
| Fields inherited from class com.liferay.portal.service.BaseServiceImpl |
|---|
ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS |
| Constructor Summary | |
|---|---|
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 folderName,
String fileName,
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 folderName,
String fileName)
|
byte[] |
exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
byte[] |
exportLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
File |
exportLayoutsAsFile(ExportImportConfiguration exportImportConfiguration)
Deprecated. As of 7.0.0, replaced by ExportImportService.exportLayoutsAsFile(
ExportImportConfiguration) |
File |
exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
long |
exportLayoutsAsFileInBackground(ExportImportConfiguration exportImportConfiguration)
Deprecated. As of 7.0.0, replaced by ExportImportService.exportLayoutsAsFileInBackground(
ExportImportConfiguration) |
long |
exportLayoutsAsFileInBackground(long exportImportConfigurationId)
Deprecated. As of 7.0.0, replaced by ExportImportService.exportLayoutsAsFileInBackground(
long) |
long |
exportLayoutsAsFileInBackground(String taskName,
long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
long |
exportLayoutsAsFileInBackground(String taskName,
long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
Deprecated. As of 7.0.0, with no direct replacement |
byte[] |
exportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
byte[] |
exportPortletInfo(long companyId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
File |
exportPortletInfoAsFile(ExportImportConfiguration exportImportConfiguration)
Deprecated. As of 7.0.0, replaced by ExportImportService.exportPortletInfoAsFile(
ExportImportConfiguration) |
File |
exportPortletInfoAsFile(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
File |
exportPortletInfoAsFile(String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
Deprecated. As of 7.0.0, with no direct replacement |
long |
exportPortletInfoAsFileInBackground(String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
Deprecated. As of 7.0.0, with no direct replacement |
long |
exportPortletInfoAsFileInBackground(String taskName,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
Deprecated. As of 7.0.0, with no direct replacement |
protected List<Layout> |
filterLayouts(List<Layout> layouts)
|
List<Layout> |
getAncestorLayouts(long plid)
Returns all the ancestor layouts of the layout. |
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[] |
getTempFileNames(long groupId,
String folderName)
|
void |
importLayouts(ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportService.importLayouts(
ExportImportConfiguration, File) |
void |
importLayouts(ExportImportConfiguration exportImportConfiguration,
InputStream is)
Deprecated. As of 7.0.0, replaced by ExportImportService.importLayouts(
ExportImportConfiguration, InputStream) |
void |
importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
byte[] bytes)
Deprecated. As of 7.0.0, with no direct replacement |
void |
importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
void |
importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
long |
importLayoutsInBackground(String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
long |
importLayoutsInBackground(String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream inputStream)
Deprecated. As of 7.0.0, with no direct replacement |
void |
importPortletInfo(ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportService.importPortletInfo(
ExportImportConfiguration, File) ( |
void |
importPortletInfo(ExportImportConfiguration exportImportConfiguration,
InputStream is)
Deprecated. As of 7.0.0, replaced by ExportImportService.importPortletInfo(
ExportImportConfiguration, InputStream) ( |
void |
importPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
void |
importPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
void |
importPortletInfo(String portletId,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
void |
importPortletInfo(String portletId,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
long |
importPortletInfoInBackground(String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
long |
importPortletInfoInBackground(String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
void |
importPortletInfoInBackground(String taskName,
String portletId,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
void |
importPortletInfoInBackground(String taskName,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
Deprecated. As of 7.0.0, with no direct replacement |
void |
schedulePublishToLive(long sourceGroupId,
long targetGroupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
String scope,
Date startDate,
Date endDate,
String groupName,
String cronText,
Date schedulerStartDate,
Date schedulerEndDate,
String description)
Deprecated. As of 7.0.0, replaced by schedulePublishToLive(long,
long, boolean, long[], Map, String, String, Date, Date,
String) |
void |
schedulePublishToLive(long sourceGroupId,
long targetGroupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
String groupName,
String cronText,
Date schedulerStartDate,
Date schedulerEndDate,
String description)
Schedules a range of layouts to be published. |
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)
Deprecated. As of 7.0.0, replaced by schedulePublishToLive(long,
long, boolean, long[], Map, String, Date, Date, String,
String, Date, Date, String) |
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 |
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 |
updateIconImage(long plid,
byte[] bytes)
|
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)
Updates the parent layout ID and 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. |
MissingReferences |
validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportService.validateImportLayoutsFile(
ExportImportConfiguration, File) |
MissingReferences |
validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
InputStream inputStream)
Deprecated. As of 7.0.0, replaced by ExportImportService.validateImportLayoutsFile(
ExportImportConfiguration, InputStream) |
MissingReferences |
validateImportLayoutsFile(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
MissingReferences |
validateImportLayoutsFile(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream inputStream)
Deprecated. As of 7.0.0, with no direct replacement |
MissingReferences |
validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
File file)
Deprecated. As of 7.0.0, replaced by ExportImportService.validateImportPortletInfo(
ExportImportConfiguration, File) |
MissingReferences |
validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
InputStream inputStream)
Deprecated. As of 7.0.0, replaced by ExportImportService.validateImportPortletInfo(
ExportImportConfiguration, InputStream) |
MissingReferences |
validateImportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
Deprecated. As of 7.0.0, with no direct replacement |
MissingReferences |
validateImportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream inputStream)
Deprecated. As of 7.0.0, with no direct replacement |
| Methods inherited from class com.liferay.portal.service.BaseServiceImpl |
|---|
getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public LayoutServiceImpl()
| Method Detail |
|---|
@Deprecated
public 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)
throws PortalException
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
public 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)
throws PortalException
This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.
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
public Layout addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
String name,
String title,
String description,
String type,
boolean hidden,
String friendlyURL,
ServiceContext serviceContext)
throws PortalException
This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.
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 - the layout's locales and localized namestitle - the layout's locales and localized titlesdescription - 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
public FileEntry addTempFileEntry(long groupId,
String folderName,
String fileName,
InputStream inputStream,
String mimeType)
throws PortalException
PortalException
public void deleteLayout(long groupId,
boolean privateLayout,
long layoutId,
ServiceContext serviceContext)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutserviceContext - the service context to be applied
PortalException
public void deleteLayout(long plid,
ServiceContext serviceContext)
throws PortalException
plid - the primary key of the layoutserviceContext - the service context to be applied
PortalException
public void deleteTempFileEntry(long groupId,
String folderName,
String fileName)
throws PortalException
PortalException
@Deprecated
public byte[] exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutIds - the primary keys of the layouts to be exportedparameterMap - the mapping of parameters indicating which
information to export. For information on the keys used in
the map see PortletDataHandlerKeys.startDate - the export's start dateendDate - the export's end date
PortalException
@Deprecated
public byte[] exportLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparameterMap - the mapping of parameters indicating which
information to export. For information on the keys used in
the map see PortletDataHandlerKeys.startDate - the export's start dateendDate - the export's end date
PortalException
@Deprecated
public File exportLayoutsAsFile(ExportImportConfiguration exportImportConfiguration)
throws PortalException
ExportImportService.exportLayoutsAsFile(
ExportImportConfiguration)
PortalException
@Deprecated
public File exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutIds - the primary keys of the layouts to be exported
(optionally null)parameterMap - the mapping of parameters indicating which
information to export. For information on the keys used in
the map see PortletDataHandlerKeys.startDate - the export's start dateendDate - the export's end date
PortalException
@Deprecated
public long exportLayoutsAsFileInBackground(ExportImportConfiguration exportImportConfiguration)
throws PortalException
ExportImportService.exportLayoutsAsFileInBackground(
ExportImportConfiguration)
PortalException
@Deprecated
public long exportLayoutsAsFileInBackground(long exportImportConfigurationId)
throws PortalException
ExportImportService.exportLayoutsAsFileInBackground(
long)
PortalException
@Deprecated
public long exportLayoutsAsFileInBackground(String taskName,
long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
PortalException
@Deprecated
public long exportLayoutsAsFileInBackground(String taskName,
long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
throws PortalException
PortalException
@Deprecated
public byte[] exportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
plid - the primary key of the layoutgroupId - the primary key of the groupportletId - the primary key of the portletparameterMap - the mapping of parameters indicating which
information to export. For information on the keys used in
the map see PortletDataHandlerKeys.startDate - the export's start dateendDate - the export's end date
PortalException
@Deprecated
public byte[] exportPortletInfo(long companyId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
PortalException
@Deprecated
public File exportPortletInfoAsFile(ExportImportConfiguration exportImportConfiguration)
throws PortalException
ExportImportService.exportPortletInfoAsFile(
ExportImportConfiguration)
PortalException
@Deprecated
public File exportPortletInfoAsFile(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
plid - the primary key of the layoutgroupId - the primary key of the groupportletId - the primary key of the portletparameterMap - the mapping of parameters indicating which
information to export. For information on the keys used in
the map see PortletDataHandlerKeys.startDate - the export's start dateendDate - the export's end date
PortalException
@Deprecated
public File exportPortletInfoAsFile(String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException
PortalException
@Deprecated
public long exportPortletInfoAsFileInBackground(String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
throws PortalException
PortalException
@Deprecated
public long exportPortletInfoAsFileInBackground(String taskName,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate,
String fileName)
throws PortalException
PortalException
public List<Layout> getAncestorLayouts(long plid)
throws PortalException
plid - the primary key of the layout
PortalException
public long getDefaultPlid(long groupId,
long scopeGroupId,
boolean privateLayout,
String portletId)
throws PortalException
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
@ThreadLocalCachable
public long getDefaultPlid(long groupId,
long scopeGroupId,
String portletId)
throws PortalException
PortalException
public Layout getLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
throws PortalException
uuid - the layout's UUIDgroupId - the primary key of the groupprivateLayout - whether the layout is private to the group
PortalException
public String getLayoutName(long groupId,
boolean privateLayout,
long layoutId,
String languageId)
throws PortalException
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
public LayoutReference[] getLayoutReferences(long companyId,
String portletId,
String preferencesKey,
String preferencesValue)
companyId - the primary key of the companyportletId - the primary key of the portletpreferencesKey - the portlet's preference keypreferencesValue - the portlet's preference value
public List<Layout> getLayouts(long groupId,
boolean privateLayout)
public List<Layout> getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
throws PortalException
PortalException
public List<Layout> getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
boolean incomplete,
int start,
int end)
throws PortalException
PortalException
public int getLayoutsCount(long groupId,
boolean privateLayout,
long parentLayoutId)
public String[] getTempFileNames(long groupId,
String folderName)
throws PortalException
PortalException
@Deprecated
public void importLayouts(ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportService.importLayouts(
ExportImportConfiguration, File)
PortalException
@Deprecated
public void importLayouts(ExportImportConfiguration exportImportConfiguration,
InputStream is)
throws PortalException
ExportImportService.importLayouts(
ExportImportConfiguration, InputStream)
PortalException
@Deprecated
public void importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
byte[] bytes)
throws PortalException
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
PortalExceptioncom.liferay.portlet.exportimport.lar.LayoutImporter
@Deprecated
public void importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
throws PortalException
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
PortalExceptioncom.liferay.portlet.exportimport.lar.LayoutImporter
@Deprecated
public void importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
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
PortalExceptioncom.liferay.portlet.exportimport.lar.LayoutImporter
@Deprecated
public long importLayoutsInBackground(String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public long importLayoutsInBackground(String taskName,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream inputStream)
throws PortalException
PortalException
@Deprecated
public void importPortletInfo(ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportService.importPortletInfo(
ExportImportConfiguration, File) (
PortalException
@Deprecated
public void importPortletInfo(ExportImportConfiguration exportImportConfiguration,
InputStream is)
throws PortalException
ExportImportService.importPortletInfo(
ExportImportConfiguration, InputStream) (
PortalException
@Deprecated
public void importPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException
plid - the primary key of the layoutgroupId - the primary key of the groupportletId - the primary key of the portletparameterMap - the mapping of parameters indicating which
information will be imported. For information on the keys
used in the map see PortletDataHandlerKeys.file - the LAR file with the data
PortalException
@Deprecated
public void importPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
plid - the primary key of the layoutgroupId - the primary key of the groupportletId - the primary key of the portletparameterMap - the mapping of parameters indicating which
information will be imported. For information on the keys
used in the map see PortletDataHandlerKeys.is - the input stream
PortalException
@Deprecated
public void importPortletInfo(String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public void importPortletInfo(String portletId,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
PortalException
@Deprecated
public long importPortletInfoInBackground(String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public long importPortletInfoInBackground(String taskName,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
PortalException
@Deprecated
public void importPortletInfoInBackground(String taskName,
String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public void importPortletInfoInBackground(String taskName,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException
PortalException
@Deprecated
public void schedulePublishToLive(long sourceGroupId,
long targetGroupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
String scope,
Date startDate,
Date endDate,
String groupName,
String cronText,
Date schedulerStartDate,
Date schedulerEndDate,
String description)
throws PortalException
schedulePublishToLive(long,
long, boolean, long[], Map, String, String, Date, Date,
String)
sourceGroupId - the primary key of the source grouptargetGroupId - the primary key of the target groupprivateLayout - whether the layout is private to the grouplayoutIds - the layouts considered for publishing, specified by
the layout IDsparameterMap - 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 #toCronTextschedulerStartDate - the scheduler start dateschedulerEndDate - the scheduler end datedescription - the scheduler description
PortalException
public void schedulePublishToLive(long sourceGroupId,
long targetGroupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
String groupName,
String cronText,
Date schedulerStartDate,
Date schedulerEndDate,
String description)
throws PortalException
sourceGroupId - the primary key of the source grouptargetGroupId - the primary key of the target groupprivateLayout - whether the layout is private to the grouplayoutIds - the layouts considered for publishing, specified by the
layout IDsparameterMap - the mapping of parameters indicating which
information will be used. See PortletDataHandlerKeys.groupName - the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.cronText - the cron text. See #toCronTextschedulerStartDate - the scheduler start dateschedulerEndDate - the scheduler end datedescription - the scheduler description
PortalException
@Deprecated
public 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
schedulePublishToLive(long,
long, boolean, long[], Map, String, Date, Date, String,
String, Date, Date, String)
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.groupName - the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.cronText - the cron text. See #toCronTextschedulerStartDate - the scheduler start dateschedulerEndDate - the scheduler end datedescription - the scheduler description
PortalException
public 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)
throws PortalException
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 #toCronTextschedulerStartDate - the scheduler start dateschedulerEndDate - the scheduler end datedescription - the scheduler description
PortalException
public void setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds,
ServiceContext serviceContext)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupparentLayoutId - the primary key of the parent layoutlayoutIds - the primary keys of the layoutsserviceContext - the service context to be applied
PortalException
public void unschedulePublishToLive(long groupId,
String jobName,
String groupName)
throws PortalException
groupId - the primary key of the groupjobName - the job namegroupName - the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
PortalException
public void unschedulePublishToRemote(long groupId,
String jobName,
String groupName)
throws PortalException
groupId - the primary key of the groupjobName - the job namegroupName - the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
PortalException
public Layout updateIconImage(long plid,
byte[] bytes)
throws PortalException
PortalException
public 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)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutparentLayoutId - the primary key of the layout's new parent 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
@Deprecated
public 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)
throws PortalException
updateLayout(long, boolean,
long, long, Map, Map, Map, Map, Map, String, boolean, Map,
boolean, byte[], ServiceContext)
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutparentLayoutId - the primary key of the layout's new parent
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
public Layout updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layouttypeSettings - the settings to load the unicode properties object.
See #fastLoad(String).
PortalException
public Layout updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
String themeId,
String colorSchemeId,
String css,
boolean wapTheme)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutthemeId - the primary key of the layout's new themecolorSchemeId - the primary key of the layout's new color schemecss - the layout's new CSSwapTheme - whether the theme is for WAP browsers
PortalException
public Layout updateName(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutname - the layout's new namelanguageId - the primary key of the language. For more information
see Locale.
PortalException
public Layout updateName(long plid,
String name,
String languageId)
throws PortalException
plid - the primary key of the layoutname - the name to be assignedlanguageId - the primary key of the language. For more information
see Locale.
PortalException
public Layout updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutparentLayoutId - the primary key to be assigned to the parent
layout
PortalException
public Layout updateParentLayoutId(long plid,
long parentPlid)
throws PortalException
LayoutConstants.DEFAULT_PARENT_LAYOUT_ID is assigned.
plid - the primary key of the layoutparentPlid - the primary key of the parent layout
PortalException
public Layout updateParentLayoutIdAndPriority(long plid,
long parentPlid,
int priority)
throws PortalException
plid - the primary key of the layoutparentPlid - the primary key of the parent layoutpriority - the layout's new priority
PortalException
public Layout updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutpriority - the layout's new priority
PortalException
public Layout updatePriority(long groupId,
boolean privateLayout,
long layoutId,
long nextLayoutId,
long previousLayoutId)
throws PortalException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the grouplayoutId - the primary key of the layoutnextLayoutId - the primary key of the next layoutpreviousLayoutId - the primary key of the previous layout
PortalException
public Layout updatePriority(long plid,
int priority)
throws PortalException
plid - the primary key of the layoutpriority - the layout's new priority
PortalException
@Deprecated
public MissingReferences validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportService.validateImportLayoutsFile(
ExportImportConfiguration, File)
PortalException
@Deprecated
public MissingReferences validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
InputStream inputStream)
throws PortalException
ExportImportService.validateImportLayoutsFile(
ExportImportConfiguration, InputStream)
PortalException
@Deprecated
public MissingReferences validateImportLayoutsFile(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public MissingReferences validateImportLayoutsFile(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream inputStream)
throws PortalException
PortalException
@Deprecated
public MissingReferences validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
File file)
throws PortalException
ExportImportService.validateImportPortletInfo(
ExportImportConfiguration, File)
PortalException
@Deprecated
public MissingReferences validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
InputStream inputStream)
throws PortalException
ExportImportService.validateImportPortletInfo(
ExportImportConfiguration, InputStream)
PortalException
@Deprecated
public MissingReferences validateImportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException
PortalException
@Deprecated
public MissingReferences validateImportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream inputStream)
throws PortalException
PortalException
protected List<Layout> filterLayouts(List<Layout> layouts)
throws PortalException
PortalException
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||