com.liferay.portal.service.http
Class LayoutServiceJSON

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

public class LayoutServiceJSON
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 JSON 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 JSON 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 a com.liferay.portal.kernel.json.JSONArray. If the method in the service utility returns a com.liferay.portal.model.Layout, that is translated to a com.liferay.portal.kernel.json.JSONObject. Methods that JSON cannot safely use are skipped. The logic for the translation is encapsulated in com.liferay.portal.service.http.LayoutJSONSerializer.

This allows you to call the the backend services directly from JavaScript. See portal-web/docroot/html/portlet/tags_admin/unpacked.js for a reference of how that portlet uses the generated JavaScript in portal-web/docroot/html/js/service.js to call the backend services directly from JavaScript.

The JSON utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
LayoutServiceUtil, LayoutJSONSerializer

Constructor Summary
LayoutServiceJSON()
           
 
Method Summary
static com.liferay.portal.kernel.json.JSONObject 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 prefsKey, java.lang.String prefsValue)
           
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.kernel.json.JSONObject updateLayout(long groupId, boolean privateLayout, long layoutId, java.lang.String typeSettings)
           
static com.liferay.portal.kernel.json.JSONObject 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.kernel.json.JSONObject updateName(long groupId, boolean privateLayout, long layoutId, java.lang.String name, java.lang.String languageId)
           
static com.liferay.portal.kernel.json.JSONObject updateName(long plid, java.lang.String name, java.lang.String languageId)
           
static com.liferay.portal.kernel.json.JSONObject updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
           
static com.liferay.portal.kernel.json.JSONObject updateParentLayoutId(long plid, long parentPlid)
           
static com.liferay.portal.kernel.json.JSONObject updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)
           
static com.liferay.portal.kernel.json.JSONObject 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

LayoutServiceJSON

public LayoutServiceJSON()
Method Detail

addLayout

public static com.liferay.portal.kernel.json.JSONObject 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,
                                                                  com.liferay.portal.PortalException,
                                                                  com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteLayout

public static void deleteLayout(long plid)
                         throws java.rmi.RemoteException,
                                com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteLayout

public static void deleteLayout(long groupId,
                                boolean privateLayout,
                                long layoutId)
                         throws java.rmi.RemoteException,
                                com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getLayoutName

public static java.lang.String getLayoutName(long groupId,
                                             boolean privateLayout,
                                             long layoutId,
                                             java.lang.String languageId)
                                      throws java.rmi.RemoteException,
                                             com.liferay.portal.PortalException,
                                             com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getLayoutReferences

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

setLayouts

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

unschedulePublishToLive

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

unschedulePublishToRemote

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

updateLayout

public static com.liferay.portal.kernel.json.JSONObject updateLayout(long groupId,
                                                                     boolean privateLayout,
                                                                     long layoutId,
                                                                     java.lang.String typeSettings)
                                                              throws java.rmi.RemoteException,
                                                                     com.liferay.portal.PortalException,
                                                                     com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateLookAndFeel

public static com.liferay.portal.kernel.json.JSONObject 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,
                                                                          com.liferay.portal.PortalException,
                                                                          com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateName

public static com.liferay.portal.kernel.json.JSONObject updateName(long plid,
                                                                   java.lang.String name,
                                                                   java.lang.String languageId)
                                                            throws java.rmi.RemoteException,
                                                                   com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateName

public static com.liferay.portal.kernel.json.JSONObject updateName(long groupId,
                                                                   boolean privateLayout,
                                                                   long layoutId,
                                                                   java.lang.String name,
                                                                   java.lang.String languageId)
                                                            throws java.rmi.RemoteException,
                                                                   com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateParentLayoutId

public static com.liferay.portal.kernel.json.JSONObject updateParentLayoutId(long plid,
                                                                             long parentPlid)
                                                                      throws java.rmi.RemoteException,
                                                                             com.liferay.portal.PortalException,
                                                                             com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateParentLayoutId

public static com.liferay.portal.kernel.json.JSONObject updateParentLayoutId(long groupId,
                                                                             boolean privateLayout,
                                                                             long layoutId,
                                                                             long parentLayoutId)
                                                                      throws java.rmi.RemoteException,
                                                                             com.liferay.portal.PortalException,
                                                                             com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updatePriority

public static com.liferay.portal.kernel.json.JSONObject updatePriority(long plid,
                                                                       int priority)
                                                                throws java.rmi.RemoteException,
                                                                       com.liferay.portal.PortalException,
                                                                       com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updatePriority

public static com.liferay.portal.kernel.json.JSONObject updatePriority(long groupId,
                                                                       boolean privateLayout,
                                                                       long layoutId,
                                                                       int priority)
                                                                throws java.rmi.RemoteException,
                                                                       com.liferay.portal.PortalException,
                                                                       com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException