com.liferay.portal.service.http
Class UserGroupServiceJSON

java.lang.Object
  extended bycom.liferay.portal.service.http.UserGroupServiceJSON

public class UserGroupServiceJSON
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.UserGroupServiceUtil 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.UserGroup, 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.UserGroupJSONSerializer.

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:
UserGroupServiceUtil, UserGroupJSONSerializer

Constructor Summary
UserGroupServiceJSON()
           
 
Method Summary
static void addGroupUserGroups(long groupId, long[] userGroupIds)
           
static org.json.JSONObject addUserGroup(java.lang.String name, java.lang.String description)
           
static void deleteUserGroup(long userGroupId)
           
static org.json.JSONObject getUserGroup(long userGroupId)
           
static org.json.JSONObject getUserGroup(java.lang.String name)
           
static org.json.JSONArray getUserUserGroups(long userId)
           
static void unsetGroupUserGroups(long groupId, long[] userGroupIds)
           
static org.json.JSONObject updateUserGroup(long userGroupId, java.lang.String name, java.lang.String description)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserGroupServiceJSON

public UserGroupServiceJSON()
Method Detail

addGroupUserGroups

public static void addGroupUserGroups(long groupId,
                                      long[] userGroupIds)
                               throws com.liferay.portal.SystemException,
                                      com.liferay.portal.PortalException,
                                      java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

addUserGroup

public static org.json.JSONObject addUserGroup(java.lang.String name,
                                               java.lang.String description)
                                        throws com.liferay.portal.SystemException,
                                               com.liferay.portal.PortalException,
                                               java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteUserGroup

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

getUserGroup

public static org.json.JSONObject getUserGroup(long userGroupId)
                                        throws com.liferay.portal.SystemException,
                                               com.liferay.portal.PortalException,
                                               java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserGroup

public static org.json.JSONObject getUserGroup(java.lang.String name)
                                        throws com.liferay.portal.SystemException,
                                               com.liferay.portal.PortalException,
                                               java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserUserGroups

public static org.json.JSONArray getUserUserGroups(long userId)
                                            throws com.liferay.portal.SystemException,
                                                   com.liferay.portal.PortalException,
                                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

unsetGroupUserGroups

public static void unsetGroupUserGroups(long groupId,
                                        long[] userGroupIds)
                                 throws com.liferay.portal.SystemException,
                                        com.liferay.portal.PortalException,
                                        java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateUserGroup

public static org.json.JSONObject updateUserGroup(long userGroupId,
                                                  java.lang.String name,
                                                  java.lang.String description)
                                           throws com.liferay.portal.SystemException,
                                                  com.liferay.portal.PortalException,
                                                  java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException