com.liferay.portal.service.http
Class OrganizationServiceJSON

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

public class OrganizationServiceJSON
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.OrganizationServiceUtil 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.Organization, 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.OrganizationJSONSerializer.

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:
OrganizationServiceUtil, OrganizationJSONSerializer

Constructor Summary
OrganizationServiceJSON()
           
 
Method Summary
static void addGroupOrganizations(long groupId, long[] organizationIds)
           
static org.json.JSONObject addOrganization(long parentOrganizationId, java.lang.String name, boolean location, boolean recursable, long regionId, long countryId, int statusId)
           
static void addPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds)
           
static void deleteOrganization(long organizationId)
           
static org.json.JSONObject getOrganization(long organizationId)
           
static long getOrganizationId(long companyId, java.lang.String name)
           
static org.json.JSONArray getUserOrganizations(long userId)
           
static void setGroupOrganizations(long groupId, long[] organizationIds)
           
static void unsetGroupOrganizations(long groupId, long[] organizationIds)
           
static void unsetPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds)
           
static org.json.JSONObject updateOrganization(long organizationId, long parentOrganizationId, java.lang.String name, boolean location, boolean recursable, long regionId, long countryId, int statusId)
           
static org.json.JSONObject updateOrganization(long organizationId, java.lang.String comments)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OrganizationServiceJSON

public OrganizationServiceJSON()
Method Detail

addGroupOrganizations

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

addPasswordPolicyOrganizations

public static void addPasswordPolicyOrganizations(long passwordPolicyId,
                                                  long[] organizationIds)
                                           throws com.liferay.portal.SystemException,
                                                  com.liferay.portal.PortalException,
                                                  java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

addOrganization

public static org.json.JSONObject addOrganization(long parentOrganizationId,
                                                  java.lang.String name,
                                                  boolean location,
                                                  boolean recursable,
                                                  long regionId,
                                                  long countryId,
                                                  int statusId)
                                           throws com.liferay.portal.SystemException,
                                                  com.liferay.portal.PortalException,
                                                  java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteOrganization

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

getOrganization

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

getOrganizationId

public static long getOrganizationId(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

getUserOrganizations

public static org.json.JSONArray getUserOrganizations(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

setGroupOrganizations

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

unsetGroupOrganizations

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

unsetPasswordPolicyOrganizations

public static void unsetPasswordPolicyOrganizations(long passwordPolicyId,
                                                    long[] organizationIds)
                                             throws com.liferay.portal.SystemException,
                                                    com.liferay.portal.PortalException,
                                                    java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateOrganization

public static org.json.JSONObject updateOrganization(long organizationId,
                                                     long parentOrganizationId,
                                                     java.lang.String name,
                                                     boolean location,
                                                     boolean recursable,
                                                     long regionId,
                                                     long countryId,
                                                     int statusId)
                                              throws com.liferay.portal.SystemException,
                                                     com.liferay.portal.PortalException,
                                                     java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateOrganization

public static org.json.JSONObject updateOrganization(long organizationId,
                                                     java.lang.String comments)
                                              throws com.liferay.portal.SystemException,
                                                     com.liferay.portal.PortalException,
                                                     java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException