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

java.lang.Object
  com.liferay.portlet.tags.service.http.TagsEntryServiceJSON

public class TagsEntryServiceJSON
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.TagsEntryServiceUtil 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.TagsEntry, 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.TagsEntryJSONSerializer.

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:

TagsEntryServiceUtil, TagsEntryJSONSerializer

Constructor Summary

TagsEntryServiceJSON()

Method Summary

static com.liferay.portal.kernel.json.JSONObject	addEntry(java.lang.String parentEntryName, java.lang.String name, java.lang.String vocabularyName, java.lang.String[] properties, com.liferay.portal.service.ServiceContext serviceContext)
static void	deleteEntry(long entryId)
static com.liferay.portal.kernel.json.JSONArray	getEntries(long groupId, long classNameId, java.lang.String name)
static com.liferay.portal.kernel.json.JSONArray	getEntries(java.lang.String className, long classPK)
static com.liferay.portal.kernel.json.JSONObject	getEntry(long entryId)
static com.liferay.portal.kernel.json.JSONArray	getGroupVocabularyEntries(long groupId, java.lang.String vocabularyName)
static com.liferay.portal.kernel.json.JSONArray	getGroupVocabularyEntries(long groupId, java.lang.String parentEntryName, java.lang.String vocabularyName)
static com.liferay.portal.kernel.json.JSONArray	getGroupVocabularyRootEntries(long groupId, java.lang.String vocabularyName)
static void	mergeEntries(long fromEntryId, long toEntryId)
static com.liferay.portal.kernel.json.JSONArray	search(long groupId, java.lang.String name, java.lang.String[] properties, int start, int end)
static com.liferay.portal.kernel.json.JSONObject	updateEntry(long entryId, java.lang.String parentEntryName, java.lang.String name, java.lang.String vocabularyName, java.lang.String[] properties)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TagsEntryServiceJSON

public TagsEntryServiceJSON()

Method Detail

addEntry

public static com.liferay.portal.kernel.json.JSONObject addEntry(java.lang.String parentEntryName,
                                                                 java.lang.String name,
                                                                 java.lang.String vocabularyName,
                                                                 java.lang.String[] properties,
                                                                 com.liferay.portal.service.ServiceContext serviceContext)
                                                          throws com.liferay.portal.PortalException,
                                                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteEntry

public static void deleteEntry(long entryId)
                        throws com.liferay.portal.PortalException,
                               com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getEntries

public static com.liferay.portal.kernel.json.JSONArray getEntries(java.lang.String className,
                                                                  long classPK)
                                                           throws com.liferay.portal.PortalException,
                                                                  com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getEntries

public static com.liferay.portal.kernel.json.JSONArray getEntries(long groupId,
                                                                  long classNameId,
                                                                  java.lang.String name)
                                                           throws com.liferay.portal.PortalException,
                                                                  com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getEntry

public static com.liferay.portal.kernel.json.JSONObject getEntry(long entryId)
                                                          throws com.liferay.portal.PortalException,
                                                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getGroupVocabularyEntries

public static com.liferay.portal.kernel.json.JSONArray getGroupVocabularyEntries(long groupId,
                                                                                 java.lang.String vocabularyName)
                                                                          throws com.liferay.portal.PortalException,
                                                                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getGroupVocabularyEntries

public static com.liferay.portal.kernel.json.JSONArray getGroupVocabularyEntries(long groupId,
                                                                                 java.lang.String parentEntryName,
                                                                                 java.lang.String vocabularyName)
                                                                          throws com.liferay.portal.PortalException,
                                                                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getGroupVocabularyRootEntries

public static com.liferay.portal.kernel.json.JSONArray getGroupVocabularyRootEntries(long groupId,
                                                                                     java.lang.String vocabularyName)
                                                                              throws com.liferay.portal.PortalException,
                                                                                     com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

mergeEntries

public static void mergeEntries(long fromEntryId,
                                long toEntryId)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

search

public static com.liferay.portal.kernel.json.JSONArray search(long groupId,
                                                              java.lang.String name,
                                                              java.lang.String[] properties,
                                                              int start,
                                                              int end)
                                                       throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

updateEntry

public static com.liferay.portal.kernel.json.JSONObject updateEntry(long entryId,
                                                                    java.lang.String parentEntryName,
                                                                    java.lang.String name,
                                                                    java.lang.String vocabularyName,
                                                                    java.lang.String[] properties)
                                                             throws com.liferay.portal.PortalException,
                                                                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException