com.liferay.portal.service.http
Class RoleServiceJSON
java.lang.Object
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
Method Summary |
static org.json.JSONObject |
addRole(java.lang.String name,
int type)
|
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 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 org.json.JSONObject |
updateRole(long roleId,
java.lang.String name)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
RoleServiceJSON
public RoleServiceJSON()
addRole
public static org.json.JSONObject addRole(java.lang.String name,
int type)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException
deleteRole
public static void deleteRole(long roleId)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException
getGroupRole
public static org.json.JSONObject getGroupRole(long companyId,
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
getGroupRoles
public static org.json.JSONArray getGroupRoles(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
getRole
public static org.json.JSONObject getRole(long roleId)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException
getRole
public static org.json.JSONObject getRole(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
getUserGroupRoles
public static org.json.JSONArray getUserGroupRoles(long userId,
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
getUserRelatedRoles
public static org.json.JSONArray getUserRelatedRoles(long userId,
java.util.List groups)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException
getUserRoles
public static org.json.JSONArray getUserRoles(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
hasUserRole
public static boolean hasUserRole(long userId,
long companyId,
java.lang.String name,
boolean inherited)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException
hasUserRoles
public static boolean hasUserRoles(long userId,
long companyId,
java.lang.String[] names,
boolean inherited)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException
updateRole
public static org.json.JSONObject updateRole(long roleId,
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