com.liferay.portal.service.http

Class LayoutServiceSoap

java.lang.Object

com.liferay.portal.service.http.LayoutServiceSoap

public class LayoutServiceSoap
extends java.lang.Object

Provides the SOAP utility for the 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.

See Also:

LayoutServiceHttp

Constructor Summary

Constructors

Constructor and Description
LayoutServiceSoap()

Method Summary

Modifier and Type	Method and Description
static LayoutSoap	addLayout(long groupId, boolean privateLayout, long parentLayoutId, java.lang.String[] localeNamesMapLanguageIds, java.lang.String[] localeNamesMapValues, java.lang.String[] localeTitlesMapLanguageIds, java.lang.String[] localeTitlesMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, java.lang.String[] keywordsMapLanguageIds, java.lang.String[] keywordsMapValues, java.lang.String[] robotsMapLanguageIds, java.lang.String[] robotsMapValues, java.lang.String type, java.lang.String typeSettings, boolean hidden, java.lang.String[] friendlyURLMapLanguageIds, java.lang.String[] friendlyURLMapValues, ServiceContext serviceContext) Adds a layout with additional parameters.
static LayoutSoap	addLayout(long groupId, boolean privateLayout, long parentLayoutId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL, 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, ServiceContext serviceContext) Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.
static void	deleteLayout(long plid, ServiceContext serviceContext) Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.
static void	deleteTempFileEntry(long groupId, java.lang.String folderName, java.lang.String fileName)
static long	exportLayoutsAsFileInBackground(ExportImportConfigurationSoap exportImportConfiguration) Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.exportLayoutsAsFileInBackground( ExportImportConfiguration)
static long	exportLayoutsAsFileInBackground(long exportImportConfigurationId) Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.exportLayoutsAsFileInBackground( long)
static LayoutSoap[]	getAncestorLayouts(long plid) Returns all the ancestor layouts of the layout.
static long	getDefaultPlid(long groupId, long scopeGroupId, boolean privateLayout, java.lang.String portletId) Returns the primary key of the default layout for the group.
static long	getDefaultPlid(long groupId, long scopeGroupId, java.lang.String portletId)
static LayoutSoap	getLayoutByUuidAndGroupId(java.lang.String uuid, long groupId, boolean privateLayout) Returns the layout matching the UUID, group, and privacy.
static java.lang.String	getLayoutName(long groupId, boolean privateLayout, long layoutId, java.lang.String languageId) Returns the name of the layout.
static LayoutReference[]	getLayoutReferences(long companyId, java.lang.String portletId, java.lang.String preferencesKey, java.lang.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 LayoutSoap[]	getLayouts(long groupId, boolean privateLayout)
static LayoutSoap[]	getLayouts(long groupId, boolean privateLayout, long parentLayoutId)
static LayoutSoap[]	getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end)
static LayoutSoap[]	getLayouts(long groupId, boolean privateLayout, java.lang.String type)
static int	getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId)
static int	getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId, int priority)
static java.lang.String[]	getTempFileNames(long groupId, java.lang.String folderName)
static 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.
static void	unschedulePublishToLive(long groupId, java.lang.String jobName, java.lang.String groupName) Deletes the job from the scheduler's queue.
static void	unschedulePublishToRemote(long groupId, java.lang.String jobName, java.lang.String groupName) Deletes the job from the scheduler's persistent queue.
static LayoutSoap	updateIconImage(long plid, byte[] bytes)
static LayoutSoap	updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, java.lang.String[] localeNamesMapLanguageIds, java.lang.String[] localeNamesMapValues, java.lang.String[] localeTitlesMapLanguageIds, java.lang.String[] localeTitlesMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, java.lang.String[] keywordsMapLanguageIds, java.lang.String[] keywordsMapValues, java.lang.String[] robotsMapLanguageIds, java.lang.String[] robotsMapValues, java.lang.String type, boolean hidden, java.lang.String[] friendlyURLMapLanguageIds, java.lang.String[] friendlyURLMapValues, boolean iconImage, byte[] iconBytes, ServiceContext serviceContext) Updates the layout with additional parameters.
static LayoutSoap	updateLayout(long groupId, boolean privateLayout, long layoutId, java.lang.String typeSettings) Updates the layout replacing its type settings.
static LayoutSoap	updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, java.lang.String themeId, java.lang.String colorSchemeId, java.lang.String css) Updates the look and feel of the layout.
static LayoutSoap	updateName(long groupId, boolean privateLayout, long layoutId, java.lang.String name, java.lang.String languageId) Updates the name of the layout matching the group, layout ID, and privacy.
static LayoutSoap	updateName(long plid, java.lang.String name, java.lang.String languageId) Updates the name of the layout matching the primary key.
static 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 LayoutSoap	updateParentLayoutId(long plid, long parentPlid) Updates the parent layout ID of the layout matching the primary key.
static LayoutSoap	updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority) Updates the parent layout ID and priority of the layout.
static LayoutSoap	updatePriority(long groupId, boolean privateLayout, long layoutId, int priority) Updates the priority of the layout matching the group, layout ID, and privacy.
static 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 LayoutSoap	updatePriority(long plid, int priority) Updates the priority of the layout matching the primary key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutServiceSoap

public LayoutServiceSoap()

Method Detail

addLayout

public static LayoutSoap addLayout(long groupId,
                                   boolean privateLayout,
                                   long parentLayoutId,
                                   java.lang.String[] localeNamesMapLanguageIds,
                                   java.lang.String[] localeNamesMapValues,
                                   java.lang.String[] localeTitlesMapLanguageIds,
                                   java.lang.String[] localeTitlesMapValues,
                                   java.lang.String[] descriptionMapLanguageIds,
                                   java.lang.String[] descriptionMapValues,
                                   java.lang.String[] keywordsMapLanguageIds,
                                   java.lang.String[] keywordsMapValues,
                                   java.lang.String[] robotsMapLanguageIds,
                                   java.lang.String[] robotsMapValues,
                                   java.lang.String type,
                                   java.lang.String typeSettings,
                                   boolean hidden,
                                   java.lang.String[] friendlyURLMapLanguageIds,
                                   java.lang.String[] friendlyURLMapValues,
                                   ServiceContext serviceContext)
                            throws java.rmi.RemoteException

Adds a layout with additional parameters.

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.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parentLayoutId - the primary key of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the layout's locales and localized descriptions

keywordsMap - the layout's locales and localized keywords

robotsMap - the layout's locales and localized robots

type - 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 hidden

friendlyURLMap - 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.

Returns:

the layout

Throws:

java.rmi.RemoteException

addLayout

public static LayoutSoap addLayout(long groupId,
                                   boolean privateLayout,
                                   long parentLayoutId,
                                   java.lang.String name,
                                   java.lang.String title,
                                   java.lang.String description,
                                   java.lang.String type,
                                   boolean hidden,
                                   java.lang.String friendlyURL,
                                   ServiceContext serviceContext)
                            throws java.rmi.RemoteException

Adds a layout with single entry maps for name, title, and description to the default locale.

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.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parentLayoutId - the primary key of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)

name - the layout's locales and localized names

title - the layout's locales and localized titles

description - the layout's locales and localized descriptions

type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.

hidden - whether the layout is hidden

friendlyURL - 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.

Returns:

the layout

Throws:

java.rmi.RemoteException

deleteLayout

public static void deleteLayout(long groupId,
                                boolean privateLayout,
                                long layoutId,
                                ServiceContext serviceContext)
                         throws java.rmi.RemoteException

Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the primary key of the layout

serviceContext - the service context to be applied

Throws:

java.rmi.RemoteException

deleteLayout

public static void deleteLayout(long plid,
                                ServiceContext serviceContext)
                         throws java.rmi.RemoteException

Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.

Parameters:

plid - the primary key of the layout

serviceContext - the service context to be applied

Throws:

java.rmi.RemoteException

deleteTempFileEntry

public static void deleteTempFileEntry(long groupId,
                                       java.lang.String folderName,
                                       java.lang.String fileName)
                                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

exportLayoutsAsFileInBackground

@Deprecated
public static long exportLayoutsAsFileInBackground(ExportImportConfigurationSoap exportImportConfiguration)
                                                        throws java.rmi.RemoteException

Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.exportLayoutsAsFileInBackground( ExportImportConfiguration)

Throws:

java.rmi.RemoteException

exportLayoutsAsFileInBackground

@Deprecated
public static long exportLayoutsAsFileInBackground(long exportImportConfigurationId)
                                                        throws java.rmi.RemoteException

Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.exportLayoutsAsFileInBackground( long)

Throws:

java.rmi.RemoteException

getAncestorLayouts

public static LayoutSoap[] getAncestorLayouts(long plid)
                                       throws java.rmi.RemoteException

Returns all the ancestor layouts of the layout.

Parameters:

plid - the primary key of the layout

Returns:

the ancestor layouts of the layout

Throws:

java.rmi.RemoteException

getDefaultPlid

public static long getDefaultPlid(long groupId,
                                  long scopeGroupId,
                                  boolean privateLayout,
                                  java.lang.String portletId)
                           throws java.rmi.RemoteException

Returns the primary key of the default layout for the group.

Parameters:

groupId - the primary key of the group

scopeGroupId - the primary key of the scope group. See ServiceContext#getScopeGroupId().

privateLayout - whether the layout is private to the group

portletId - the primary key of the portlet

Returns:

Returns the primary key of the default layout group; LayoutConstants#DEFAULT_PLID otherwise

Throws:

java.rmi.RemoteException

getDefaultPlid

public static long getDefaultPlid(long groupId,
                                  long scopeGroupId,
                                  java.lang.String portletId)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getLayoutByUuidAndGroupId

public static LayoutSoap getLayoutByUuidAndGroupId(java.lang.String uuid,
                                                   long groupId,
                                                   boolean privateLayout)
                                            throws java.rmi.RemoteException

Returns the layout matching the UUID, group, and privacy.

Parameters:

uuid - the layout's UUID

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

Returns:

the matching layout

Throws:

java.rmi.RemoteException

getLayoutName

public static java.lang.String getLayoutName(long groupId,
                                             boolean privateLayout,
                                             long layoutId,
                                             java.lang.String languageId)
                                      throws java.rmi.RemoteException

Returns the name of the layout.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the primary key of the layout

languageId - the primary key of the language. For more information See Locale.

Returns:

the layout's name

Throws:

java.rmi.RemoteException

getLayoutReferences

public static LayoutReference[] getLayoutReferences(long companyId,
                                                    java.lang.String portletId,
                                                    java.lang.String preferencesKey,
                                                    java.lang.String preferencesValue)
                                             throws java.rmi.RemoteException

Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences.

Parameters:

companyId - the primary key of the company

portletId - the primary key of the portlet

preferencesKey - the portlet's preference key

preferencesValue - the portlet's preference value

Returns:

the layout references of the matching layouts

Throws:

java.rmi.RemoteException

getLayouts

public static LayoutSoap[] getLayouts(long groupId,
                                      boolean privateLayout)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getLayouts

public static LayoutSoap[] getLayouts(long groupId,
                                      boolean privateLayout,
                                      long parentLayoutId)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getLayouts

public static LayoutSoap[] getLayouts(long groupId,
                                      boolean privateLayout,
                                      long parentLayoutId,
                                      boolean incomplete,
                                      int start,
                                      int end)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getLayouts

public static LayoutSoap[] getLayouts(long groupId,
                                      boolean privateLayout,
                                      java.lang.String type)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getLayoutsCount

public static int getLayoutsCount(long groupId,
                                  boolean privateLayout,
                                  long parentLayoutId)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getLayoutsCount

public static int getLayoutsCount(long groupId,
                                  boolean privateLayout,
                                  long parentLayoutId,
                                  int priority)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getTempFileNames

public static java.lang.String[] getTempFileNames(long groupId,
                                                  java.lang.String folderName)
                                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setLayouts

public static void setLayouts(long groupId,
                              boolean privateLayout,
                              long parentLayoutId,
                              long[] layoutIds,
                              ServiceContext serviceContext)
                       throws java.rmi.RemoteException

Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parentLayoutId - the primary key of the parent layout

layoutIds - the primary keys of the layouts

serviceContext - the service context to be applied

Throws:

java.rmi.RemoteException

unschedulePublishToLive

public static void unschedulePublishToLive(long groupId,
                                           java.lang.String jobName,
                                           java.lang.String groupName)
                                    throws java.rmi.RemoteException

Deletes the job from the scheduler's queue.

Parameters:

groupId - the primary key of the group

jobName - the job name

groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.

Throws:

java.rmi.RemoteException

unschedulePublishToRemote

public static void unschedulePublishToRemote(long groupId,
                                             java.lang.String jobName,
                                             java.lang.String groupName)
                                      throws java.rmi.RemoteException

Deletes the job from the scheduler's persistent queue.

Parameters:

groupId - the primary key of the group

jobName - the job name

groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.

Throws:

java.rmi.RemoteException

updateIconImage

public static LayoutSoap updateIconImage(long plid,
                                         byte[] bytes)
                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateLayout

public static LayoutSoap updateLayout(long groupId,
                                      boolean privateLayout,
                                      long layoutId,
                                      long parentLayoutId,
                                      java.lang.String[] localeNamesMapLanguageIds,
                                      java.lang.String[] localeNamesMapValues,
                                      java.lang.String[] localeTitlesMapLanguageIds,
                                      java.lang.String[] localeTitlesMapValues,
                                      java.lang.String[] descriptionMapLanguageIds,
                                      java.lang.String[] descriptionMapValues,
                                      java.lang.String[] keywordsMapLanguageIds,
                                      java.lang.String[] keywordsMapValues,
                                      java.lang.String[] robotsMapLanguageIds,
                                      java.lang.String[] robotsMapValues,
                                      java.lang.String type,
                                      boolean hidden,
                                      java.lang.String[] friendlyURLMapLanguageIds,
                                      java.lang.String[] friendlyURLMapValues,
                                      boolean iconImage,
                                      byte[] iconBytes,
                                      ServiceContext serviceContext)
                               throws java.rmi.RemoteException

Updates the layout with additional parameters.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the primary key of the layout

parentLayoutId - the primary key of the layout's new parent layout

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the locales and localized descriptions to merge (optionally null)

keywordsMap - the locales and localized keywords to merge (optionally null)

robotsMap - the locales and localized robots to merge (optionally null)

type - the layout's new type (optionally LayoutConstants#TYPE_PORTLET)

hidden - whether the layout is hidden

friendlyURLMap - 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 updated

iconBytes - the byte array of the layout's new icon image

serviceContext - the service context to be applied. Can set the modification date and expando bridge attributes for the layout.

Returns:

the updated layout

Throws:

java.rmi.RemoteException

updateLayout

public static LayoutSoap updateLayout(long groupId,
                                      boolean privateLayout,
                                      long layoutId,
                                      java.lang.String typeSettings)
                               throws java.rmi.RemoteException

Updates the layout replacing its type settings.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the primary key of the layout

typeSettings - the settings to load the unicode properties object. See #fastLoad(String).

Returns:

the updated layout

Throws:

java.rmi.RemoteException

updateLookAndFeel

public static LayoutSoap updateLookAndFeel(long groupId,
                                           boolean privateLayout,
                                           long layoutId,
                                           java.lang.String themeId,
                                           java.lang.String colorSchemeId,
                                           java.lang.String css)
                                    throws java.rmi.RemoteException

Updates the look and feel of the layout.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the primary key of the layout

themeId - the primary key of the layout's new theme

colorSchemeId - the primary key of the layout's new color scheme

css - the layout's new CSS

Returns:

the updated layout

Throws:

java.rmi.RemoteException

updateName

public static LayoutSoap updateName(long groupId,
                                    boolean privateLayout,
                                    long layoutId,
                                    java.lang.String name,
                                    java.lang.String languageId)
                             throws java.rmi.RemoteException

Updates the name of the layout matching the group, layout ID, and privacy.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the primary key of the layout

name - the layout's new name

languageId - the primary key of the language. For more information see Locale.

Returns:

the updated layout

Throws:

java.rmi.RemoteException

updateName

public static LayoutSoap updateName(long plid,
                                    java.lang.String name,
                                    java.lang.String languageId)
                             throws java.rmi.RemoteException

Updates the name of the layout matching the primary key.

Parameters:

plid - the primary key of the layout

name - the name to be assigned

languageId - the primary key of the language. For more information see Locale.

Returns:

the updated layout

Throws:

java.rmi.RemoteException

updateParentLayoutId

public static LayoutSoap updateParentLayoutId(long groupId,
                                              boolean privateLayout,
                                              long layoutId,
                                              long parentLayoutId)
                                       throws java.rmi.RemoteException

Updates the parent layout ID of the layout matching the group, layout ID, and privacy.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the primary key of the layout

parentLayoutId - the primary key to be assigned to the parent layout

Returns:

the matching layout

Throws:

java.rmi.RemoteException

updateParentLayoutId

public static LayoutSoap updateParentLayoutId(long plid,
                                              long parentPlid)
                                       throws java.rmi.RemoteException

Updates the parent layout ID of the layout matching the primary key. If a layout matching the parent primary key is found, the layout ID of that layout is assigned, otherwise LayoutConstants#DEFAULT_PARENT_LAYOUT_ID is assigned.

Parameters:

plid - the primary key of the layout

parentPlid - the primary key of the parent layout

Returns:

the layout matching the primary key

Throws:

java.rmi.RemoteException

updateParentLayoutIdAndPriority

public static LayoutSoap updateParentLayoutIdAndPriority(long plid,
                                                         long parentPlid,
                                                         int priority)
                                                  throws java.rmi.RemoteException

Updates the parent layout ID and priority of the layout.

Parameters:

plid - the primary key of the layout

parentPlid - the primary key of the parent layout

priority - the layout's new priority

Returns:

the layout matching the primary key

Throws:

java.rmi.RemoteException

updatePriority

public static LayoutSoap updatePriority(long groupId,
                                        boolean privateLayout,
                                        long layoutId,
                                        int priority)
                                 throws java.rmi.RemoteException

Updates the priority of the layout matching the group, layout ID, and privacy.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the primary key of the layout

priority - the layout's new priority

Returns:

the updated layout

Throws:

java.rmi.RemoteException

updatePriority

public static LayoutSoap updatePriority(long groupId,
                                        boolean privateLayout,
                                        long layoutId,
                                        long nextLayoutId,
                                        long previousLayoutId)
                                 throws java.rmi.RemoteException

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.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the primary key of the layout

nextLayoutId - the primary key of the next layout

previousLayoutId - the primary key of the previous layout

Returns:

the updated layout

Throws:

java.rmi.RemoteException

updatePriority

public static LayoutSoap updatePriority(long plid,
                                        int priority)
                                 throws java.rmi.RemoteException

Updates the priority of the layout matching the primary key.

Parameters:

plid - the primary key of the layout

priority - the layout's new priority

Returns:

the updated layout

Throws:

java.rmi.RemoteException