public class LayoutServiceWrapper extends Object implements LayoutService, ServiceWrapper<LayoutService>
LayoutService
.LayoutService
Constructor and Description |
---|
LayoutServiceWrapper() |
LayoutServiceWrapper(LayoutService layoutService) |
Modifier and Type | Method and Description |
---|---|
Layout |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
long classNameId,
long classPK,
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,
boolean system,
Map<Locale,String> friendlyURLMap,
long masterLayoutPlid,
ServiceContext serviceContext)
Adds a layout with additional parameters.
|
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,
long masterLayoutPlid,
ServiceContext serviceContext)
Adds a layout with additional parameters.
|
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) |
Layout |
copyLayout(long groupId,
boolean privateLayout,
Map<Locale,String> localeNamesMap,
boolean hidden,
boolean system,
boolean copyPermissions,
long sourcePlid,
ServiceContext serviceContext) |
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) |
Layout |
fetchLayout(long groupId,
boolean privateLayout,
long layoutId) |
long |
fetchLayoutPlid(String uuid,
long groupId,
boolean privateLayout) |
List<Layout> |
getAncestorLayouts(long plid)
Returns all the ancestor layouts of the layout.
|
long |
getControlPanelLayoutPlid()
Returns the control panel layout's plid.
|
long |
getDefaultPlid(long groupId,
boolean privateLayout)
Returns primary key of the matching default layout for the group.
|
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.
|
long |
getLayoutPlid(String uuid,
long groupId,
boolean privateLayout)
Returns the layout's plid that matches the parameters.
|
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) |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
int start,
int end) |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String type) |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String type,
int start,
int end) |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String keywords,
String[] types,
int[] statuses,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String keywords,
String[] types,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
List<Layout> |
getLayouts(long groupId,
String type) |
List<Layout> |
getLayouts(long groupId,
String type,
int start,
int end) |
int |
getLayoutsCount(long groupId,
boolean privateLayout) |
int |
getLayoutsCount(long groupId,
boolean privateLayout,
long parentLayoutId) |
int |
getLayoutsCount(long groupId,
boolean privateLayout,
long parentLayoutId,
int priority) |
int |
getLayoutsCount(long groupId,
boolean privateLayout,
String type) |
int |
getLayoutsCount(long groupId,
boolean privateLayout,
String keywords,
String[] types) |
int |
getLayoutsCount(long groupId,
boolean privateLayout,
String keywords,
String[] types,
int[] statuses) |
int |
getLayoutsCount(long groupId,
String type) |
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
String[] |
getTempFileNames(long groupId,
String folderName) |
LayoutService |
getWrappedService() |
boolean |
hasLayout(String uuid,
long groupId,
boolean privateLayout)
Returns
true if there is a matching layout with the UUID,
group, and privacy. |
boolean |
hasPortletId(long plid,
String portletId) |
Layout |
publishLayout(long plid) |
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 |
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 |
setWrappedService(LayoutService layoutService) |
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 hasIconImage,
byte[] iconBytes,
long styleBookEntryId,
long faviconFileEntryId,
long masterLayoutPlid,
ServiceContext serviceContext)
Updates the layout with additional parameters.
|
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)
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.
|
Layout |
updateType(long plid,
String type) |
public LayoutServiceWrapper()
public LayoutServiceWrapper(LayoutService layoutService)
public Layout addLayout(long groupId, boolean privateLayout, long parentLayoutId, long classNameId, long classPK, 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, boolean system, Map<Locale,String> friendlyURLMap, long masterLayoutPlid, 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.
addLayout
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout (optionally
LayoutConstants#DEFAULT_PARENT_LAYOUT_ID
)classNameId
- the class name ID of the entityclassPK
- the primary key of the entitylocaleNamesMap
- 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 hiddensystem
- whether the layout is systemfriendlyURLMap
- the layout's locales and localized friendly URLs.
To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize(
String)
.masterLayoutPlid
- the primary key of the master layoutserviceContext
- 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 portal exception occurredpublic 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, long masterLayoutPlid, 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.
addLayout
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID 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)
.masterLayoutPlid
- the primary key of the master layoutserviceContext
- 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 portal exception occurredpublic 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.
addLayout
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID 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 portal exception occurredpublic 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.
addLayout
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID 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
- if a portal exception occurredpublic FileEntry addTempFileEntry(long groupId, String folderName, String fileName, InputStream inputStream, String mimeType) throws PortalException
addTempFileEntry
in interface LayoutService
PortalException
public Layout copyLayout(long groupId, boolean privateLayout, Map<Locale,String> localeNamesMap, boolean hidden, boolean system, boolean copyPermissions, long sourcePlid, ServiceContext serviceContext) throws PortalException
copyLayout
in interface LayoutService
PortalException
public void deleteLayout(long groupId, boolean privateLayout, long layoutId, ServiceContext serviceContext) throws PortalException
deleteLayout
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredpublic void deleteLayout(long plid, ServiceContext serviceContext) throws PortalException
deleteLayout
in interface LayoutService
plid
- the primary key of the layoutserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredpublic void deleteTempFileEntry(long groupId, String folderName, String fileName) throws PortalException
deleteTempFileEntry
in interface LayoutService
PortalException
public Layout fetchLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException
fetchLayout
in interface LayoutService
PortalException
public long fetchLayoutPlid(String uuid, long groupId, boolean privateLayout) throws PortalException
fetchLayoutPlid
in interface LayoutService
PortalException
public List<Layout> getAncestorLayouts(long plid) throws PortalException
getAncestorLayouts
in interface LayoutService
plid
- the primary key of the layoutPortalException
- if a portal exception occurredpublic long getControlPanelLayoutPlid() throws PortalException
getControlPanelLayoutPlid
in interface LayoutService
PortalException
- if a portal exception is occuredpublic long getDefaultPlid(long groupId, boolean privateLayout)
getDefaultPlid
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupLayoutConstants#DEFAULT_PLID
) otherwisepublic long getDefaultPlid(long groupId, long scopeGroupId, boolean privateLayout, String portletId) throws PortalException
getDefaultPlid
in interface LayoutService
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 portletLayoutConstants#DEFAULT_PLID
otherwisePortalException
- if a portal exception occurredpublic long getDefaultPlid(long groupId, long scopeGroupId, String portletId) throws PortalException
getDefaultPlid
in interface LayoutService
PortalException
public Layout getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout) throws PortalException
getLayoutByUuidAndGroupId
in interface LayoutService
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupPortalException
- if a portal exception occurredpublic String getLayoutName(long groupId, boolean privateLayout, long layoutId, String languageId) throws PortalException
getLayoutName
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutlanguageId
- the primary key of the language. For more information
See Locale
.PortalException
- if a portal exception occurredpublic long getLayoutPlid(String uuid, long groupId, boolean privateLayout) throws PortalException
getLayoutPlid
in interface LayoutService
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupPortalException
- if a portal exception occurredpublic LayoutReference[] getLayoutReferences(long companyId, String portletId, String preferencesKey, String preferencesValue)
getLayoutReferences
in interface LayoutService
companyId
- the primary key of the companyportletId
- the primary key of the portletpreferencesKey
- the portlet's preference keypreferencesValue
- the portlet's preference valuepublic List<Layout> getLayouts(long groupId, boolean privateLayout)
getLayouts
in interface LayoutService
public List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId) throws PortalException
getLayouts
in interface LayoutService
PortalException
public List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end) throws PortalException
getLayouts
in interface LayoutService
PortalException
public List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, int start, int end) throws PortalException
getLayouts
in interface LayoutService
PortalException
public List<Layout> getLayouts(long groupId, boolean privateLayout, String type) throws PortalException
getLayouts
in interface LayoutService
PortalException
public List<Layout> getLayouts(long groupId, boolean privateLayout, String type, int start, int end) throws PortalException
getLayouts
in interface LayoutService
PortalException
public List<Layout> getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
getLayouts
in interface LayoutService
PortalException
public List<Layout> getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
getLayouts
in interface LayoutService
PortalException
public List<Layout> getLayouts(long groupId, String type)
getLayouts
in interface LayoutService
public List<Layout> getLayouts(long groupId, String type, int start, int end)
getLayouts
in interface LayoutService
public int getLayoutsCount(long groupId, boolean privateLayout)
getLayoutsCount
in interface LayoutService
public int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId)
getLayoutsCount
in interface LayoutService
public int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId, int priority)
getLayoutsCount
in interface LayoutService
public int getLayoutsCount(long groupId, boolean privateLayout, String type)
getLayoutsCount
in interface LayoutService
public int getLayoutsCount(long groupId, boolean privateLayout, String keywords, String[] types) throws PortalException
getLayoutsCount
in interface LayoutService
PortalException
public int getLayoutsCount(long groupId, boolean privateLayout, String keywords, String[] types, int[] statuses) throws PortalException
getLayoutsCount
in interface LayoutService
PortalException
public int getLayoutsCount(long groupId, String type)
getLayoutsCount
in interface LayoutService
public String getOSGiServiceIdentifier()
getOSGiServiceIdentifier
in interface LayoutService
public String[] getTempFileNames(long groupId, String folderName) throws PortalException
getTempFileNames
in interface LayoutService
PortalException
public boolean hasLayout(String uuid, long groupId, boolean privateLayout) throws PortalException
true
if there is a matching layout with the UUID,
group, and privacy.hasLayout
in interface LayoutService
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouptrue
if the layout is found; false
otherwisePortalException
- if a portal exception occurredpublic boolean hasPortletId(long plid, String portletId) throws PortalException
hasPortletId
in interface LayoutService
PortalException
public Layout publishLayout(long plid) throws Exception
publishLayout
in interface LayoutService
Exception
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
schedulePublishToLive
in interface LayoutService
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 CronTextUtil.getCronText(javax.portlet.PortletRequest, java.util.Calendar, boolean, int)
schedulerStartDate
- the scheduler start dateschedulerEndDate
- the scheduler end datedescription
- the scheduler descriptionPortalException
- if a portal exception occurredpublic 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
schedulePublishToRemote
in interface LayoutService
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 CronTextUtil.getCronText(javax.portlet.PortletRequest, java.util.Calendar, boolean, int)
schedulerStartDate
- the scheduler start dateschedulerEndDate
- the scheduler end datedescription
- the scheduler descriptionPortalException
- if a portal exception occurredpublic void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds, ServiceContext serviceContext) throws PortalException
setLayouts
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layoutlayoutIds
- the primary keys of the layoutsserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredpublic void unschedulePublishToLive(long groupId, String jobName, String groupName) throws PortalException
unschedulePublishToLive
in interface LayoutService
groupId
- the primary key of the groupjobName
- the job namegroupName
- the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER
). See DestinationNames
.PortalException
- if a portal exception occurredpublic void unschedulePublishToRemote(long groupId, String jobName, String groupName) throws PortalException
unschedulePublishToRemote
in interface LayoutService
groupId
- the primary key of the groupjobName
- the job namegroupName
- the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER
). See DestinationNames
.PortalException
- if a portal exception occurredpublic Layout updateIconImage(long plid, byte[] bytes) throws PortalException
updateIconImage
in interface LayoutService
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 hasIconImage, byte[] iconBytes, long styleBookEntryId, long faviconFileEntryId, long masterLayoutPlid, ServiceContext serviceContext) throws PortalException
updateLayout
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutparentLayoutId
- the layout ID 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)
.hasIconImage
- if the layout has a custom icon imageiconBytes
- the byte array of the layout's new icon imagestyleBookEntryId
- the primary key of the style book entryfaviconFileEntryId
- the file entry ID of the layout's new faviconmasterLayoutPlid
- the primary key of the master layoutserviceContext
- the service context to be applied. Can set the
modification date and expando bridge attributes for the layout.PortalException
- if a portal exception occurredpublic Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings) throws PortalException
updateLayout
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layouttypeSettings
- the settings to load the unicode properties object.
See #fastLoad(String)
.PortalException
- if a portal exception occurredpublic Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css) throws PortalException
updateLookAndFeel
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID 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 CSSPortalException
- if a portal exception occurredpublic Layout updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId) throws PortalException
updateName
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutname
- the layout's new namelanguageId
- the primary key of the language. For more information
see Locale
.PortalException
- if a portal exception occurredpublic Layout updateName(long plid, String name, String languageId) throws PortalException
updateName
in interface LayoutService
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 portal exception occurredpublic Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId) throws PortalException
updateParentLayoutId
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutparentLayoutId
- the layout ID to be assigned to the parent layoutPortalException
- if a portal exception occurredpublic Layout updateParentLayoutId(long plid, long parentPlid) throws PortalException
LayoutConstants#DEFAULT_PARENT_LAYOUT_ID
is assigned.updateParentLayoutId
in interface LayoutService
plid
- the primary key of the layoutparentPlid
- the primary key of the parent layoutPortalException
- if a portal exception occurredpublic Layout updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority) throws PortalException
updateParentLayoutIdAndPriority
in interface LayoutService
plid
- the primary key of the layoutparentPlid
- the primary key of the parent layoutpriority
- the layout's new priorityPortalException
- if a portal exception occurredpublic Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority) throws PortalException
updatePriority
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutpriority
- the layout's new priorityPortalException
- if a portal exception occurredpublic Layout updatePriority(long groupId, boolean privateLayout, long layoutId, long nextLayoutId, long previousLayoutId) throws PortalException
updatePriority
in interface LayoutService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutnextLayoutId
- the layout ID of the next layoutpreviousLayoutId
- the layout ID of the previous layoutPortalException
- if a portal exception occurredpublic Layout updatePriority(long plid, int priority) throws PortalException
updatePriority
in interface LayoutService
plid
- the primary key of the layoutpriority
- the layout's new priorityPortalException
- if a portal exception occurredpublic Layout updateType(long plid, String type) throws PortalException
updateType
in interface LayoutService
PortalException
public LayoutService getWrappedService()
getWrappedService
in interface ServiceWrapper<LayoutService>
public void setWrappedService(LayoutService layoutService)
setWrappedService
in interface ServiceWrapper<LayoutService>