com.liferay.portlet.imagegallery.service.http
Class IGImageServiceJSON

java.lang.Object
  extended by com.liferay.portlet.imagegallery.service.http.IGImageServiceJSON

public class IGImageServiceJSON
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.imagegallery.service.IGImageServiceUtil 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.imagegallery.model.IGImage, 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.imagegallery.service.http.IGImageJSONSerializer.

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:
IGImageServiceUtil, IGImageJSONSerializer

Constructor Summary
IGImageServiceJSON()
           
 
Method Summary
static void deleteImage(long imageId)
           
static void deleteImageByFolderIdAndNameWithExtension(long folderId, java.lang.String nameWithExtension)
           
static com.liferay.portal.kernel.json.JSONObject getImage(long imageId)
           
static com.liferay.portal.kernel.json.JSONObject getImageByFolderIdAndNameWithExtension(long folderId, java.lang.String nameWithExtension)
           
static com.liferay.portal.kernel.json.JSONObject getImageByLargeImageId(long largeImageId)
           
static com.liferay.portal.kernel.json.JSONObject getImageBySmallImageId(long smallImageId)
           
static com.liferay.portal.kernel.json.JSONArray getImages(long folderId)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IGImageServiceJSON

public IGImageServiceJSON()
Method Detail

deleteImage

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

deleteImageByFolderIdAndNameWithExtension

public static void deleteImageByFolderIdAndNameWithExtension(long folderId,
                                                             java.lang.String nameWithExtension)
                                                      throws java.rmi.RemoteException,
                                                             com.liferay.portal.PortalException,
                                                             com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getImage

public static com.liferay.portal.kernel.json.JSONObject getImage(long imageId)
                                                          throws java.rmi.RemoteException,
                                                                 com.liferay.portal.PortalException,
                                                                 com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getImageByFolderIdAndNameWithExtension

public static com.liferay.portal.kernel.json.JSONObject getImageByFolderIdAndNameWithExtension(long folderId,
                                                                                               java.lang.String nameWithExtension)
                                                                                        throws java.rmi.RemoteException,
                                                                                               com.liferay.portal.PortalException,
                                                                                               com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getImageByLargeImageId

public static com.liferay.portal.kernel.json.JSONObject getImageByLargeImageId(long largeImageId)
                                                                        throws java.rmi.RemoteException,
                                                                               com.liferay.portal.PortalException,
                                                                               com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getImageBySmallImageId

public static com.liferay.portal.kernel.json.JSONObject getImageBySmallImageId(long smallImageId)
                                                                        throws java.rmi.RemoteException,
                                                                               com.liferay.portal.PortalException,
                                                                               com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getImages

public static com.liferay.portal.kernel.json.JSONArray getImages(long folderId)
                                                          throws java.rmi.RemoteException,
                                                                 com.liferay.portal.PortalException,
                                                                 com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException