public class LayoutServiceSoap
extends Object
LayoutServiceUtil service
utility. The static methods of this class call the same methods of the
service utility. However, the signatures are different because it is
difficult for SOAP to support certain types.
ServiceBuilder follows certain rules in translating the methods. For example,
if the method in the service utility returns a java.util.List,
that is translated to an array of
com.liferay.portal.kernel.model.LayoutSoap. If the method in the
service utility returns a
com.liferay.portal.kernel.model.Layout, that is translated to a
com.liferay.portal.kernel.model.LayoutSoap. Methods that SOAP
cannot safely wire are skipped.
The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).
You can see a list of services at http://localhost:8080/api/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.
The SOAP utility is only generated for remote services.
LayoutServiceHttp| Constructor and Description |
|---|
LayoutServiceSoap() |
| Modifier and Type | Method and Description |
|---|---|
static com.liferay.portal.kernel.model.LayoutSoap |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
long classNameId,
long classPK,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
boolean system,
long masterLayoutPlid,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deprecated.
As of Mueller (7.2.x), replaced by
#addLayout(long,
boolean, long, long, long, Map, Map, Map, Map, Map, String,
String, boolean, boolean, Map, long, ServiceContext) |
static com.liferay.portal.kernel.model.LayoutSoap |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
long classNameId,
long classPK,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
boolean system,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
long masterLayoutPlid,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a layout with additional parameters.
|
static com.liferay.portal.kernel.model.LayoutSoap |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
long classNameId,
long classPK,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
boolean system,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deprecated.
As of Mueller (7.2.x), replaced by
#addLayout(long,
boolean, long, long, long, Map, Map, Map, Map, Map, String,
String, boolean, boolean, long, Map, ServiceContext) |
static com.liferay.portal.kernel.model.LayoutSoap |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
long masterLayoutPlid,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deprecated.
As of Athanasius (7.3.x), replaced by
#addLayout(long,
boolean, long, long, long, Map, Map, Map, Map, Map, String,
String, boolean, boolean, Map, long, ServiceContext) |
static com.liferay.portal.kernel.model.LayoutSoap |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
long masterLayoutPlid,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a layout with additional parameters.
|
static com.liferay.portal.kernel.model.LayoutSoap |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a layout with additional parameters.
|
static com.liferay.portal.kernel.model.LayoutSoap |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
String name,
String title,
String description,
String type,
boolean hidden,
String friendlyURL,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a layout with single entry maps for name, title, and description to
the default locale.
|
static void |
deleteLayout(long groupId,
boolean privateLayout,
long layoutId,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deletes the layout with the primary key, also deleting the layout's child
layouts, and associated resources.
|
static void |
deleteLayout(long plid,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deletes the layout with the plid, also deleting the layout's child
layouts, and associated resources.
|
static void |
deleteTempFileEntry(long groupId,
String folderName,
String fileName) |
static com.liferay.portal.kernel.model.LayoutSoap |
fetchLayout(long groupId,
boolean privateLayout,
long layoutId) |
static com.liferay.portal.kernel.model.LayoutSoap[] |
getAncestorLayouts(long plid)
Returns all the ancestor layouts of the layout.
|
static long |
getControlPanelLayoutPlid()
Returns the control panel layout's plid.
|
static long |
getDefaultPlid(long groupId,
boolean privateLayout)
Returns primary key of the matching default layout for the group.
|
static long |
getDefaultPlid(long groupId,
long scopeGroupId,
boolean privateLayout,
String portletId)
Returns the primary key of the default layout for the group.
|
static long |
getDefaultPlid(long groupId,
long scopeGroupId,
String portletId) |
static com.liferay.portal.kernel.model.LayoutSoap |
getLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
Returns the layout matching the UUID, group, and privacy.
|
static String |
getLayoutName(long groupId,
boolean privateLayout,
long layoutId,
String languageId)
Returns the name of the layout.
|
static long |
getLayoutPlid(String uuid,
long groupId,
boolean privateLayout)
Returns the layout's plid that matches the parameters.
|
static com.liferay.portal.kernel.model.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.
|
static com.liferay.portal.kernel.model.LayoutSoap[] |
getLayouts(long groupId,
boolean privateLayout) |
static com.liferay.portal.kernel.model.LayoutSoap[] |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId) |
static com.liferay.portal.kernel.model.LayoutSoap[] |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
boolean incomplete,
int start,
int end) |
static com.liferay.portal.kernel.model.LayoutSoap[] |
getLayouts(long groupId,
boolean privateLayout,
String type) |
static com.liferay.portal.kernel.model.LayoutSoap[] |
getLayouts(long groupId,
boolean privateLayout,
String type,
int start,
int end) |
static com.liferay.portal.kernel.model.LayoutSoap[] |
getLayouts(long groupId,
boolean privateLayout,
String keywords,
String[] types,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Layout> orderByComparator) |
static com.liferay.portal.kernel.model.LayoutSoap[] |
getLayouts(long groupId,
String type) |
static com.liferay.portal.kernel.model.LayoutSoap[] |
getLayouts(long groupId,
String type,
int start,
int end) |
static int |
getLayoutsCount(long groupId,
boolean privateLayout) |
static int |
getLayoutsCount(long groupId,
boolean privateLayout,
long parentLayoutId) |
static int |
getLayoutsCount(long groupId,
boolean privateLayout,
long parentLayoutId,
int priority) |
static int |
getLayoutsCount(long groupId,
boolean privateLayout,
String type) |
static int |
getLayoutsCount(long groupId,
boolean privateLayout,
String keywords,
String[] types) |
static int |
getLayoutsCount(long groupId,
String type) |
static String[] |
getTempFileNames(long groupId,
String folderName) |
static boolean |
hasLayout(String uuid,
long groupId,
boolean privateLayout)
Returns
true if there is a matching layout with the UUID,
group, and privacy. |
static boolean |
hasPortletId(long plid,
String portletId) |
static void |
setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Sets the layouts for the group, replacing and prioritizing all layouts of
the parent layout.
|
static void |
unschedulePublishToLive(long groupId,
String jobName,
String groupName)
Deletes the job from the scheduler's queue.
|
static void |
unschedulePublishToRemote(long groupId,
String jobName,
String groupName)
Deletes the job from the scheduler's persistent queue.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updateIconImage(long plid,
byte[] bytes) |
static com.liferay.portal.kernel.model.LayoutSoap |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
boolean hidden,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
boolean hasIconImage,
byte[] iconBytes,
long masterLayoutPlid,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the layout with additional parameters.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
boolean hidden,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
boolean hasIconImage,
byte[] iconBytes,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deprecated.
As of Athanasius (7.3.x), replaced by
#updateLayout(long, boolean, long, long, Map, Map, Map, Map,
Map, String, boolean, Map, boolean, byte[], long,
ServiceContext) |
static com.liferay.portal.kernel.model.LayoutSoap |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings)
Updates the layout replacing its type settings.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
String themeId,
String colorSchemeId,
String css)
Updates the look and feel of the layout.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updateName(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
Updates the name of the layout matching the group, layout ID, and
privacy.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updateName(long plid,
String name,
String languageId)
Updates the name of the layout matching the primary key.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
Updates the parent layout ID of the layout matching the group, layout ID,
and privacy.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updateParentLayoutId(long plid,
long parentPlid)
Updates the parent layout ID of the layout matching the primary key.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updateParentLayoutIdAndPriority(long plid,
long parentPlid,
int priority)
Updates the parent layout ID and priority of the layout.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
Updates the priority of the layout matching the group, layout ID, and
privacy.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updatePriority(long groupId,
boolean privateLayout,
long layoutId,
long nextLayoutId,
long previousLayoutId)
Updates the priority of the layout matching the group, layout ID, and
privacy, setting the layout's priority based on the priorities of the
next and previous layouts.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updatePriority(long plid,
int priority)
Updates the priority of the layout matching the primary key.
|
static com.liferay.portal.kernel.model.LayoutSoap |
updateType(long plid,
String type) |
@Deprecated
public static com.liferay.portal.kernel.model.LayoutSoap addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
long classNameId,
long classPK,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
boolean system,
long masterLayoutPlid,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
#addLayout(long,
boolean, long, long, long, Map, Map, Map, Map, Map, String,
String, boolean, boolean, Map, long, 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 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 systemmasterLayoutPlid - the primary key of the master layoutfriendlyURLMap - 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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
long classNameId,
long classPK,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
boolean system,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
long masterLayoutPlid,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
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 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 occurredRemoteException@Deprecated
public static com.liferay.portal.kernel.model.LayoutSoap addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
long classNameId,
long classPK,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
boolean system,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
#addLayout(long,
boolean, long, long, long, Map, Map, Map, Map, Map, String,
String, boolean, boolean, long, 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 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).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 occurredRemoteException@Deprecated
public static com.liferay.portal.kernel.model.LayoutSoap addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
long masterLayoutPlid,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
#addLayout(long,
boolean, long, long, long, Map, Map, Map, Map, Map, String,
String, boolean, boolean, Map, long, 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 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 hiddenmasterLayoutPlid - the primary key of the master layoutfriendlyURLMap - 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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
long masterLayoutPlid,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
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 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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
String typeSettings,
boolean hidden,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
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 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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
String name,
String title,
String description,
String type,
boolean hidden,
String friendlyURL,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
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 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 occurredRemoteExceptionpublic static void deleteLayout(long groupId,
boolean privateLayout,
long layoutId,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
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 occurredRemoteExceptionpublic static void deleteLayout(long plid,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
plid - the primary key of the layoutserviceContext - the service context to be appliedPortalException - if a portal exception occurredRemoteExceptionpublic static void deleteTempFileEntry(long groupId,
String folderName,
String fileName)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap fetchLayout(long groupId,
boolean privateLayout,
long layoutId)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap[] getAncestorLayouts(long plid)
throws RemoteException
plid - the primary key of the layoutPortalException - if a portal exception occurredRemoteExceptionpublic static long getControlPanelLayoutPlid()
throws RemoteException
PortalException - if a portal exception is occuredRemoteExceptionpublic static long getDefaultPlid(long groupId,
boolean privateLayout)
throws RemoteException
groupId - the primary key of the groupprivateLayout - whether the layout is private to the groupLayoutConstants#DEFAULT_PLID) otherwiseRemoteExceptionpublic static long getDefaultPlid(long groupId,
long scopeGroupId,
boolean privateLayout,
String portletId)
throws RemoteException
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 occurredRemoteExceptionpublic static long getDefaultPlid(long groupId,
long scopeGroupId,
String portletId)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap getLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
throws RemoteException
uuid - the layout's UUIDgroupId - the primary key of the groupprivateLayout - whether the layout is private to the groupPortalException - if a portal exception occurredRemoteExceptionpublic static String getLayoutName(long groupId,
boolean privateLayout,
long layoutId,
String languageId)
throws RemoteException
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 occurredRemoteExceptionpublic static long getLayoutPlid(String uuid,
long groupId,
boolean privateLayout)
throws RemoteException
uuid - the layout's UUIDgroupId - the primary key of the groupprivateLayout - whether the layout is private to the groupPortalException - if a portal exception occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutReference[] getLayoutReferences(long companyId,
String portletId,
String preferencesKey,
String preferencesValue)
throws RemoteException
companyId - the primary key of the companyportletId - the primary key of the portletpreferencesKey - the portlet's preference keypreferencesValue - the portlet's preference valueRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap[] getLayouts(long groupId,
boolean privateLayout)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap[] getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap[] getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
boolean incomplete,
int start,
int end)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap[] getLayouts(long groupId,
boolean privateLayout,
String type)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap[] getLayouts(long groupId,
boolean privateLayout,
String type,
int start,
int end)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap[] getLayouts(long groupId,
boolean privateLayout,
String keywords,
String[] types,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Layout> orderByComparator)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap[] getLayouts(long groupId,
String type)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap[] getLayouts(long groupId,
String type,
int start,
int end)
throws RemoteException
RemoteExceptionpublic static int getLayoutsCount(long groupId,
boolean privateLayout)
throws RemoteException
RemoteExceptionpublic static int getLayoutsCount(long groupId,
boolean privateLayout,
long parentLayoutId)
throws RemoteException
RemoteExceptionpublic static int getLayoutsCount(long groupId,
boolean privateLayout,
long parentLayoutId,
int priority)
throws RemoteException
RemoteExceptionpublic static int getLayoutsCount(long groupId,
boolean privateLayout,
String type)
throws RemoteException
RemoteExceptionpublic static int getLayoutsCount(long groupId,
boolean privateLayout,
String keywords,
String[] types)
throws RemoteException
RemoteExceptionpublic static int getLayoutsCount(long groupId,
String type)
throws RemoteException
RemoteExceptionpublic static String[] getTempFileNames(long groupId,
String folderName)
throws RemoteException
RemoteExceptionpublic static boolean hasLayout(String uuid,
long groupId,
boolean privateLayout)
throws RemoteException
true if there is a matching layout with the UUID,
group, and privacy.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 occurredRemoteExceptionpublic static boolean hasPortletId(long plid,
String portletId)
throws RemoteException
RemoteExceptionpublic static void setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
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 occurredRemoteExceptionpublic static void unschedulePublishToLive(long groupId,
String jobName,
String groupName)
throws RemoteException
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 occurredRemoteExceptionpublic static void unschedulePublishToRemote(long groupId,
String jobName,
String groupName)
throws RemoteException
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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updateIconImage(long plid,
byte[] bytes)
throws RemoteException
RemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
boolean hidden,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
boolean hasIconImage,
byte[] iconBytes,
long masterLayoutPlid,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
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 imagemasterLayoutPlid - 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 occurredRemoteException@Deprecated
public static com.liferay.portal.kernel.model.LayoutSoap updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId,
String[] localeNamesMapLanguageIds,
String[] localeNamesMapValues,
String[] localeTitlesMapLanguageIds,
String[] localeTitlesMapValues,
String[] descriptionMapLanguageIds,
String[] descriptionMapValues,
String[] keywordsMapLanguageIds,
String[] keywordsMapValues,
String[] robotsMapLanguageIds,
String[] robotsMapValues,
String type,
boolean hidden,
String[] friendlyURLMapLanguageIds,
String[] friendlyURLMapValues,
boolean hasIconImage,
byte[] iconBytes,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws RemoteException
#updateLayout(long, boolean, long, long, Map, Map, Map, Map,
Map, String, boolean, Map, boolean, byte[], long,
ServiceContext)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 imageserviceContext - the service context to be applied. Can set the
modification date and expando bridge attributes for the
layout.PortalException - if a portal exception occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings)
throws RemoteException
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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
String themeId,
String colorSchemeId,
String css)
throws RemoteException
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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updateName(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
throws RemoteException
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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updateName(long plid,
String name,
String languageId)
throws RemoteException
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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
throws RemoteException
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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updateParentLayoutId(long plid,
long parentPlid)
throws RemoteException
LayoutConstants#DEFAULT_PARENT_LAYOUT_ID is assigned.plid - the primary key of the layoutparentPlid - the primary key of the parent layoutPortalException - if a portal exception occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updateParentLayoutIdAndPriority(long plid,
long parentPlid,
int priority)
throws RemoteException
plid - the primary key of the layoutparentPlid - the primary key of the parent layoutpriority - the layout's new priorityPortalException - if a portal exception occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
throws RemoteException
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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updatePriority(long groupId,
boolean privateLayout,
long layoutId,
long nextLayoutId,
long previousLayoutId)
throws RemoteException
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 occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updatePriority(long plid,
int priority)
throws RemoteException
plid - the primary key of the layoutpriority - the layout's new priorityPortalException - if a portal exception occurredRemoteExceptionpublic static com.liferay.portal.kernel.model.LayoutSoap updateType(long plid,
String type)
throws RemoteException
RemoteException