com.liferay.portal.service.http
Class LayoutServiceJSON
java.lang.Object
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 org.json.JSONArray
. If the method in the
service utility returns a com.liferay.portal.model.Layout
,
that is translated to a org.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
Method Summary |
static org.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 org.json.JSONObject |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String typeSettings)
|
static org.json.JSONObject |
updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String themeId,
java.lang.String colorSchemeId,
java.lang.String css,
boolean wapTheme)
|
static org.json.JSONObject |
updateName(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String name,
java.lang.String languageId)
|
static org.json.JSONObject |
updateName(long plid,
java.lang.String name,
java.lang.String languageId)
|
static org.json.JSONObject |
updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
|
static org.json.JSONObject |
updateParentLayoutId(long plid,
long parentPlid)
|
static org.json.JSONObject |
updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
|
static org.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 |
LayoutServiceJSON
public LayoutServiceJSON()
addLayout
public static org.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.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
deleteLayout
public static void deleteLayout(long plid)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
deleteLayout
public static void deleteLayout(long groupId,
boolean privateLayout,
long layoutId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getLayoutName
public static java.lang.String getLayoutName(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String languageId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
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.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateLayout
public static org.json.JSONObject updateLayout(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String typeSettings)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateLookAndFeel
public static org.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.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateName
public static org.json.JSONObject updateName(long plid,
java.lang.String name,
java.lang.String languageId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateName
public static org.json.JSONObject updateName(long groupId,
boolean privateLayout,
long layoutId,
java.lang.String name,
java.lang.String languageId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateParentLayoutId
public static org.json.JSONObject updateParentLayoutId(long plid,
long parentPlid)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateParentLayoutId
public static org.json.JSONObject updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updatePriority
public static org.json.JSONObject updatePriority(long plid,
int priority)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updatePriority
public static org.json.JSONObject updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException