com.liferay.portal.service.http
Class LayoutServiceSoap

java.lang.Object
  extended by com.liferay.portal.service.http.LayoutServiceSoap

public class LayoutServiceSoap
extends java.lang.Object

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This class provides a SOAP utility for the com.liferay.portal.service.LayoutServiceUtil service utility. The static methods of this class calls 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.model.LayoutSoap. If the method in the service utility returns a com.liferay.portal.model.Layout, that is translated to a com.liferay.portal.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/tunnel-web/secure/axis. Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
LayoutSoap, LayoutServiceUtil, LayoutServiceHttp

Constructor Summary
LayoutServiceSoap()
           
 
Method Summary
static com.liferay.portal.model.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)
           
static void deleteLayout(long plid)
           
static void deleteLayout(long groupId, boolean privateLayout, long layoutId)
           
static java.lang.String getLayoutName(long groupId, boolean privateLayout, long layoutId, java.lang.String languageId)
           
static com.liferay.portal.model.LayoutReference[] getLayoutReferences(long companyId, java.lang.String portletId, java.lang.String preferencesKey, java.lang.String preferencesValue)
           
static void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds)
           
static void unschedulePublishToLive(long groupId, java.lang.String jobName, java.lang.String groupName)
           
static void unschedulePublishToRemote(long groupId, java.lang.String jobName, java.lang.String groupName)
           
static com.liferay.portal.model.LayoutSoap updateLayout(long groupId, boolean privateLayout, long layoutId, java.lang.String typeSettings)
           
static com.liferay.portal.model.LayoutSoap updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, java.lang.String themeId, java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
           
static com.liferay.portal.model.LayoutSoap updateName(long groupId, boolean privateLayout, long layoutId, java.lang.String name, java.lang.String languageId)
           
static com.liferay.portal.model.LayoutSoap updateName(long plid, java.lang.String name, java.lang.String languageId)
           
static com.liferay.portal.model.LayoutSoap updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
           
static com.liferay.portal.model.LayoutSoap updateParentLayoutId(long plid, long parentPlid)
           
static com.liferay.portal.model.LayoutSoap updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)
           
static com.liferay.portal.model.LayoutSoap updatePriority(long plid, int priority)
           
 
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 com.liferay.portal.model.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)
                                                     throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

deleteLayout

public static void deleteLayout(long plid)
                         throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

deleteLayout

public static void deleteLayout(long groupId,
                                boolean privateLayout,
                                long layoutId)
                         throws java.rmi.RemoteException
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
Throws:
java.rmi.RemoteException

getLayoutReferences

public static com.liferay.portal.model.LayoutReference[] getLayoutReferences(long companyId,
                                                                             java.lang.String portletId,
                                                                             java.lang.String preferencesKey,
                                                                             java.lang.String preferencesValue)
                                                                      throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

setLayouts

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

unschedulePublishToLive

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

unschedulePublishToRemote

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

updateLayout

public static com.liferay.portal.model.LayoutSoap updateLayout(long groupId,
                                                               boolean privateLayout,
                                                               long layoutId,
                                                               java.lang.String typeSettings)
                                                        throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

updateLookAndFeel

public static com.liferay.portal.model.LayoutSoap updateLookAndFeel(long groupId,
                                                                    boolean privateLayout,
                                                                    long layoutId,
                                                                    java.lang.String themeId,
                                                                    java.lang.String colorSchemeId,
                                                                    java.lang.String css,
                                                                    boolean wapTheme)
                                                             throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

updateName

public static com.liferay.portal.model.LayoutSoap updateName(long plid,
                                                             java.lang.String name,
                                                             java.lang.String languageId)
                                                      throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

updateName

public static com.liferay.portal.model.LayoutSoap updateName(long groupId,
                                                             boolean privateLayout,
                                                             long layoutId,
                                                             java.lang.String name,
                                                             java.lang.String languageId)
                                                      throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

updateParentLayoutId

public static com.liferay.portal.model.LayoutSoap updateParentLayoutId(long plid,
                                                                       long parentPlid)
                                                                throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

updateParentLayoutId

public static com.liferay.portal.model.LayoutSoap updateParentLayoutId(long groupId,
                                                                       boolean privateLayout,
                                                                       long layoutId,
                                                                       long parentLayoutId)
                                                                throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

updatePriority

public static com.liferay.portal.model.LayoutSoap updatePriority(long plid,
                                                                 int priority)
                                                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

updatePriority

public static com.liferay.portal.model.LayoutSoap updatePriority(long groupId,
                                                                 boolean privateLayout,
                                                                 long layoutId,
                                                                 int priority)
                                                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException