com.liferay.portal.service.http
Class GroupServiceJSON
java.lang.Object
com.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
com.liferay.portal.kernel.json.JSONArray
. If the method in the
service utility returns a com.liferay.portal.model.Group
,
that is translated to a
com.liferay.portal.kernel.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
Method Summary |
static com.liferay.portal.kernel.json.JSONObject |
addGroup(long liveGroupId,
java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean active)
|
static com.liferay.portal.kernel.json.JSONObject |
addGroup(java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean active)
|
static void |
addRoleGroups(long roleId,
long[] groupIds)
|
static void |
deleteGroup(long groupId)
|
static com.liferay.portal.kernel.json.JSONObject |
getGroup(long groupId)
|
static com.liferay.portal.kernel.json.JSONObject |
getGroup(long companyId,
java.lang.String name)
|
static com.liferay.portal.kernel.json.JSONArray |
getOrganizationsGroups(java.util.List<com.liferay.portal.model.Organization> organizations)
|
static com.liferay.portal.kernel.json.JSONArray |
getUserGroupsGroups(java.util.List<com.liferay.portal.model.UserGroup> userGroups)
|
static boolean |
hasUserGroup(long userId,
long groupId)
|
static com.liferay.portal.kernel.json.JSONArray |
search(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.String[] params,
int start,
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 com.liferay.portal.kernel.json.JSONObject |
updateFriendlyURL(long groupId,
java.lang.String friendlyURL)
|
static com.liferay.portal.kernel.json.JSONObject |
updateGroup(long groupId,
java.lang.String typeSettings)
|
static com.liferay.portal.kernel.json.JSONObject |
updateGroup(long groupId,
java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean active)
|
static com.liferay.portal.kernel.json.JSONObject |
updateWorkflow(long groupId,
boolean workflowEnabled,
int workflowStages,
java.lang.String workflowRoleNames)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
GroupServiceJSON
public GroupServiceJSON()
addGroup
public static com.liferay.portal.kernel.json.JSONObject addGroup(java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean active)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
addGroup
public static com.liferay.portal.kernel.json.JSONObject addGroup(long liveGroupId,
java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean active)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
addRoleGroups
public static void addRoleGroups(long roleId,
long[] groupIds)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
deleteGroup
public static void deleteGroup(long groupId)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getGroup
public static com.liferay.portal.kernel.json.JSONObject getGroup(long groupId)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getGroup
public static com.liferay.portal.kernel.json.JSONObject getGroup(long companyId,
java.lang.String name)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getOrganizationsGroups
public static com.liferay.portal.kernel.json.JSONArray getOrganizationsGroups(java.util.List<com.liferay.portal.model.Organization> organizations)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
getUserGroupsGroups
public static com.liferay.portal.kernel.json.JSONArray getUserGroupsGroups(java.util.List<com.liferay.portal.model.UserGroup> userGroups)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
hasUserGroup
public static boolean hasUserGroup(long userId,
long groupId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
search
public static com.liferay.portal.kernel.json.JSONArray search(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.String[] params,
int start,
int end)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
searchCount
public static int searchCount(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.String[] params)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
setRoleGroups
public static void setRoleGroups(long roleId,
long[] groupIds)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
unsetRoleGroups
public static void unsetRoleGroups(long roleId,
long[] groupIds)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
updateFriendlyURL
public static com.liferay.portal.kernel.json.JSONObject updateFriendlyURL(long groupId,
java.lang.String friendlyURL)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
updateGroup
public static com.liferay.portal.kernel.json.JSONObject updateGroup(long groupId,
java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean active)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
updateGroup
public static com.liferay.portal.kernel.json.JSONObject updateGroup(long groupId,
java.lang.String typeSettings)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
updateWorkflow
public static com.liferay.portal.kernel.json.JSONObject updateWorkflow(long groupId,
boolean workflowEnabled,
int workflowStages,
java.lang.String workflowRoleNames)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException