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

java.lang.Object
  extended bycom.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 org.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.tags.model.TagsEntry, 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.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 org.json.JSONObject addEntry(java.lang.String name)
           
static org.json.JSONObject addEntry(java.lang.String name, java.lang.String[] properties)
           
static void deleteEntry(long entryId)
           
static org.json.JSONArray getEntries(java.lang.String className, long classPK)
           
static org.json.JSONArray search(long companyId, java.lang.String name, java.lang.String[] properties)
           
static org.json.JSONArray search(long companyId, java.lang.String name, java.lang.String[] properties, int begin, int end)
           
static org.json.JSONArray searchAutocomplete(long companyId, java.lang.String name, java.lang.String[] properties, int begin, int end)
           
static int searchCount(long companyId, java.lang.String name, java.lang.String[] properties)
           
static org.json.JSONObject updateEntry(long entryId, java.lang.String name)
           
static org.json.JSONObject updateEntry(long entryId, java.lang.String name, 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 org.json.JSONObject addEntry(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

addEntry

public static org.json.JSONObject addEntry(java.lang.String name,
                                           java.lang.String[] properties)
                                    throws com.liferay.portal.SystemException,
                                           com.liferay.portal.PortalException,
                                           java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteEntry

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

getEntries

public static org.json.JSONArray getEntries(java.lang.String className,
                                            long classPK)
                                     throws com.liferay.portal.SystemException,
                                            com.liferay.portal.PortalException,
                                            java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

search

public static org.json.JSONArray search(long companyId,
                                        java.lang.String name,
                                        java.lang.String[] properties)
                                 throws com.liferay.portal.SystemException,
                                        java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

search

public static org.json.JSONArray search(long companyId,
                                        java.lang.String name,
                                        java.lang.String[] properties,
                                        int begin,
                                        int end)
                                 throws com.liferay.portal.SystemException,
                                        java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

searchAutocomplete

public static org.json.JSONArray searchAutocomplete(long companyId,
                                                    java.lang.String name,
                                                    java.lang.String[] properties,
                                                    int begin,
                                                    int end)
                                             throws com.liferay.portal.SystemException,
                                                    java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

searchCount

public static int searchCount(long companyId,
                              java.lang.String name,
                              java.lang.String[] properties)
                       throws com.liferay.portal.SystemException,
                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

updateEntry

public static org.json.JSONObject updateEntry(long entryId,
                                              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

updateEntry

public static org.json.JSONObject updateEntry(long entryId,
                                              java.lang.String name,
                                              java.lang.String[] properties)
                                       throws com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException,
                                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException