com.liferay.portal.service.http
Class RoleServiceJSON

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

public class RoleServiceJSON
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.RoleServiceUtil 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.Role, 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.RoleJSONSerializer.

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:
RoleServiceUtil, RoleJSONSerializer

Constructor Summary
RoleServiceJSON()
           
 
Method Summary
static org.json.JSONObject addRole(java.lang.String name, java.lang.String description, int type)
           
static void addUserRoles(long userId, long[] roleIds)
           
static void deleteRole(long roleId)
           
static org.json.JSONObject getGroupRole(long companyId, long groupId)
           
static org.json.JSONArray getGroupRoles(long groupId)
           
static org.json.JSONObject getRole(long roleId)
           
static org.json.JSONObject getRole(long companyId, java.lang.String name)
           
static org.json.JSONArray getUserGroupRoles(long userId, long groupId)
           
static org.json.JSONArray getUserRelatedRoles(long userId, java.util.List<com.liferay.portal.model.Group> groups)
           
static org.json.JSONArray getUserRoles(long userId)
           
static boolean hasUserRole(long userId, long companyId, java.lang.String name, boolean inherited)
           
static boolean hasUserRoles(long userId, long companyId, java.lang.String[] names, boolean inherited)
           
static void unsetUserRoles(long userId, long[] roleIds)
           
static org.json.JSONObject updateRole(long roleId, 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

RoleServiceJSON

public RoleServiceJSON()
Method Detail

addRole

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

addUserRoles

public static void addUserRoles(long userId,
                                long[] roleIds)
                         throws java.rmi.RemoteException,
                                com.liferay.portal.SystemException,
                                com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteRole

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

getGroupRole

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

getGroupRoles

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

getRole

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

getRole

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

getUserGroupRoles

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

getUserRelatedRoles

public static org.json.JSONArray getUserRelatedRoles(long userId,
                                                     java.util.List<com.liferay.portal.model.Group> groups)
                                              throws java.rmi.RemoteException,
                                                     com.liferay.portal.SystemException,
                                                     com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getUserRoles

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

hasUserRole

public static boolean hasUserRole(long userId,
                                  long companyId,
                                  java.lang.String name,
                                  boolean inherited)
                           throws java.rmi.RemoteException,
                                  com.liferay.portal.SystemException,
                                  com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

hasUserRoles

public static boolean hasUserRoles(long userId,
                                   long companyId,
                                   java.lang.String[] names,
                                   boolean inherited)
                            throws java.rmi.RemoteException,
                                   com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

unsetUserRoles

public static void unsetUserRoles(long userId,
                                  long[] roleIds)
                           throws java.rmi.RemoteException,
                                  com.liferay.portal.SystemException,
                                  com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateRole

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