com.liferay.portal.service.http
Class CompanyServiceJSON

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

public class CompanyServiceJSON
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.CompanyServiceUtil 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.Company, 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.CompanyJSONSerializer.

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:
CompanyServiceUtil, CompanyJSONSerializer

Constructor Summary
CompanyServiceJSON()
           
 
Method Summary
static com.liferay.portal.kernel.json.JSONObject addCompany(java.lang.String webId, java.lang.String virtualHost, java.lang.String mx)
           
static com.liferay.portal.kernel.json.JSONObject getCompanyById(long companyId)
           
static com.liferay.portal.kernel.json.JSONObject getCompanyByLogoId(long logoId)
           
static com.liferay.portal.kernel.json.JSONObject getCompanyByMx(java.lang.String mx)
           
static com.liferay.portal.kernel.json.JSONObject getCompanyByVirtualHost(java.lang.String virtualHost)
           
static com.liferay.portal.kernel.json.JSONObject getCompanyByWebId(java.lang.String webId)
           
static com.liferay.portal.kernel.json.JSONObject updateCompany(long companyId, java.lang.String virtualHost, java.lang.String mx)
           
static com.liferay.portal.kernel.json.JSONObject updateCompany(long companyId, java.lang.String virtualHost, java.lang.String mx, java.lang.String homeURL, java.lang.String name, java.lang.String legalName, java.lang.String legalId, java.lang.String legalType, java.lang.String sicCode, java.lang.String tickerSymbol, java.lang.String industry, java.lang.String type, java.lang.String size)
           
static void updateDisplay(long companyId, java.lang.String languageId, java.lang.String timeZoneId)
           
static void updateSecurity(long companyId, java.lang.String authType, boolean autoLogin, boolean sendPassword, boolean strangers, boolean strangersWithMx, boolean strangersVerify, boolean communityLogo)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CompanyServiceJSON

public CompanyServiceJSON()
Method Detail

addCompany

public static com.liferay.portal.kernel.json.JSONObject addCompany(java.lang.String webId,
                                                                   java.lang.String virtualHost,
                                                                   java.lang.String mx)
                                                            throws com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCompanyById

public static com.liferay.portal.kernel.json.JSONObject getCompanyById(long companyId)
                                                                throws com.liferay.portal.PortalException,
                                                                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCompanyByLogoId

public static com.liferay.portal.kernel.json.JSONObject getCompanyByLogoId(long logoId)
                                                                    throws com.liferay.portal.PortalException,
                                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCompanyByMx

public static com.liferay.portal.kernel.json.JSONObject getCompanyByMx(java.lang.String mx)
                                                                throws com.liferay.portal.PortalException,
                                                                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCompanyByVirtualHost

public static com.liferay.portal.kernel.json.JSONObject getCompanyByVirtualHost(java.lang.String virtualHost)
                                                                         throws com.liferay.portal.PortalException,
                                                                                com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCompanyByWebId

public static com.liferay.portal.kernel.json.JSONObject getCompanyByWebId(java.lang.String webId)
                                                                   throws com.liferay.portal.PortalException,
                                                                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateCompany

public static com.liferay.portal.kernel.json.JSONObject updateCompany(long companyId,
                                                                      java.lang.String virtualHost,
                                                                      java.lang.String mx)
                                                               throws com.liferay.portal.PortalException,
                                                                      com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateCompany

public static com.liferay.portal.kernel.json.JSONObject updateCompany(long companyId,
                                                                      java.lang.String virtualHost,
                                                                      java.lang.String mx,
                                                                      java.lang.String homeURL,
                                                                      java.lang.String name,
                                                                      java.lang.String legalName,
                                                                      java.lang.String legalId,
                                                                      java.lang.String legalType,
                                                                      java.lang.String sicCode,
                                                                      java.lang.String tickerSymbol,
                                                                      java.lang.String industry,
                                                                      java.lang.String type,
                                                                      java.lang.String size)
                                                               throws com.liferay.portal.PortalException,
                                                                      com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateDisplay

public static void updateDisplay(long companyId,
                                 java.lang.String languageId,
                                 java.lang.String timeZoneId)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateSecurity

public static void updateSecurity(long companyId,
                                  java.lang.String authType,
                                  boolean autoLogin,
                                  boolean sendPassword,
                                  boolean strangers,
                                  boolean strangersWithMx,
                                  boolean strangersVerify,
                                  boolean communityLogo)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException