com.liferay.portlet.tags.service.http
Class TagsVocabularyServiceJSON

java.lang.Object
  extended by com.liferay.portlet.tags.service.http.TagsVocabularyServiceJSON

public class TagsVocabularyServiceJSON
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.portlet.tags.service.TagsVocabularyServiceUtil 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.portlet.tags.model.TagsVocabulary, 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.portlet.tags.service.http.TagsVocabularyJSONSerializer.

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:
TagsVocabularyServiceUtil, TagsVocabularyJSONSerializer

Constructor Summary
TagsVocabularyServiceJSON()
           
 
Method Summary
static com.liferay.portal.kernel.json.JSONObject addVocabulary(java.lang.String name, boolean folksonomy, com.liferay.portal.service.ServiceContext serviceContext)
           
static void deleteVocabulary(long vocabularyId)
           
static com.liferay.portal.kernel.json.JSONArray getCompanyVocabularies(long companyId, boolean folksonomy)
           
static com.liferay.portal.kernel.json.JSONArray getGroupVocabularies(long groupId, boolean folksonomy)
           
static com.liferay.portal.kernel.json.JSONObject getVocabulary(long vocabularyId)
           
static com.liferay.portal.kernel.json.JSONObject updateVocabulary(long vocabularyId, java.lang.String name, boolean folksonomy)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TagsVocabularyServiceJSON

public TagsVocabularyServiceJSON()
Method Detail

addVocabulary

public static com.liferay.portal.kernel.json.JSONObject addVocabulary(java.lang.String name,
                                                                      boolean folksonomy,
                                                                      com.liferay.portal.service.ServiceContext serviceContext)
                                                               throws com.liferay.portal.PortalException,
                                                                      com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteVocabulary

public static void deleteVocabulary(long vocabularyId)
                             throws com.liferay.portal.PortalException,
                                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCompanyVocabularies

public static com.liferay.portal.kernel.json.JSONArray getCompanyVocabularies(long companyId,
                                                                              boolean folksonomy)
                                                                       throws com.liferay.portal.PortalException,
                                                                              com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getGroupVocabularies

public static com.liferay.portal.kernel.json.JSONArray getGroupVocabularies(long groupId,
                                                                            boolean folksonomy)
                                                                     throws com.liferay.portal.PortalException,
                                                                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getVocabulary

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

updateVocabulary

public static com.liferay.portal.kernel.json.JSONObject updateVocabulary(long vocabularyId,
                                                                         java.lang.String name,
                                                                         boolean folksonomy)
                                                                  throws com.liferay.portal.PortalException,
                                                                         com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException