com.liferay.portal.service.http
Class GroupServiceJSON

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

public class GroupServiceJSON
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.GroupServiceUtil 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.Group, 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.GroupJSONSerializer.

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:
GroupServiceUtil, GroupJSONSerializer

Constructor Summary
GroupServiceJSON()
           
 
Method Summary
static org.json.JSONObject addGroup(long liveGroupId, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String friendlyURL, boolean active)
           
static org.json.JSONObject addGroup(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String friendlyURL, boolean active)
           
static void addRoleGroups(long roleId, long[] groupIds)
           
static void deleteGroup(long groupId)
           
static org.json.JSONObject getGroup(long groupId)
           
static org.json.JSONObject getGroup(long companyId, java.lang.String name)
           
static org.json.JSONArray getOrganizationsGroups(java.util.List organizations)
           
static org.json.JSONArray getUserGroupsGroups(java.util.List userGroups)
           
static boolean hasUserGroup(long userId, long groupId)
           
static org.json.JSONArray search(long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params, int begin, int end)
           
static int searchCount(long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params)
           
static void setRoleGroups(long roleId, long[] groupIds)
           
static void unsetRoleGroups(long roleId, long[] groupIds)
           
static org.json.JSONObject updateGroup(long groupId, java.lang.String typeSettings)
           
static org.json.JSONObject updateGroup(long groupId, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String friendlyURL, boolean active)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupServiceJSON

public GroupServiceJSON()
Method Detail

addGroup

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

addGroup

public static org.json.JSONObject addGroup(long liveGroupId,
                                           java.lang.String name,
                                           java.lang.String description,
                                           java.lang.String type,
                                           java.lang.String friendlyURL,
                                           boolean active)
                                    throws com.liferay.portal.SystemException,
                                           com.liferay.portal.PortalException,
                                           java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

addRoleGroups

public static void addRoleGroups(long roleId,
                                 long[] groupIds)
                          throws com.liferay.portal.SystemException,
                                 com.liferay.portal.PortalException,
                                 java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteGroup

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

getGroup

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

getGroup

public static org.json.JSONObject getGroup(long companyId,
                                           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

getOrganizationsGroups

public static org.json.JSONArray getOrganizationsGroups(java.util.List organizations)
                                                 throws com.liferay.portal.SystemException,
                                                        com.liferay.portal.PortalException,
                                                        java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserGroupsGroups

public static org.json.JSONArray getUserGroupsGroups(java.util.List userGroups)
                                              throws com.liferay.portal.SystemException,
                                                     com.liferay.portal.PortalException,
                                                     java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

hasUserGroup

public static boolean hasUserGroup(long userId,
                                   long groupId)
                            throws com.liferay.portal.SystemException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

search

public static org.json.JSONArray search(long companyId,
                                        java.lang.String name,
                                        java.lang.String description,
                                        java.lang.String[] params,
                                        int begin,
                                        int end)
                                 throws com.liferay.portal.SystemException,
                                        java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

searchCount

public static int searchCount(long companyId,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.String[] params)
                       throws com.liferay.portal.SystemException,
                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

setRoleGroups

public static void setRoleGroups(long roleId,
                                 long[] groupIds)
                          throws com.liferay.portal.SystemException,
                                 com.liferay.portal.PortalException,
                                 java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

unsetRoleGroups

public static void unsetRoleGroups(long roleId,
                                   long[] groupIds)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateGroup

public static org.json.JSONObject updateGroup(long groupId,
                                              java.lang.String name,
                                              java.lang.String description,
                                              java.lang.String type,
                                              java.lang.String friendlyURL,
                                              boolean active)
                                       throws com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException,
                                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateGroup

public static org.json.JSONObject updateGroup(long groupId,
                                              java.lang.String typeSettings)
                                       throws com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException,
                                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException