com.liferay.portlet.documentlibrary.service.http
Class DLFileShortcutServiceJSON

java.lang.Object
  extended by com.liferay.portlet.documentlibrary.service.http.DLFileShortcutServiceJSON

public class DLFileShortcutServiceJSON
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.documentlibrary.service.DLFileShortcutServiceUtil 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.documentlibrary.model.DLFileShortcut, 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.documentlibrary.service.http.DLFileShortcutJSONSerializer.

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:
DLFileShortcutServiceUtil, DLFileShortcutJSONSerializer

Constructor Summary
DLFileShortcutServiceJSON()
           
 
Method Summary
static com.liferay.portal.kernel.json.JSONObject addFileShortcut(long folderId, long toFolderId, java.lang.String toName, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static com.liferay.portal.kernel.json.JSONObject addFileShortcut(long folderId, long toFolderId, java.lang.String toName, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static void deleteFileShortcut(long fileShortcutId)
           
static com.liferay.portal.kernel.json.JSONObject getFileShortcut(long fileShortcutId)
           
static com.liferay.portal.kernel.json.JSONObject updateFileShortcut(long fileShortcutId, long folderId, long toFolderId, java.lang.String toName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLFileShortcutServiceJSON

public DLFileShortcutServiceJSON()
Method Detail

addFileShortcut

public static com.liferay.portal.kernel.json.JSONObject addFileShortcut(long folderId,
                                                                        long toFolderId,
                                                                        java.lang.String toName,
                                                                        boolean addCommunityPermissions,
                                                                        boolean addGuestPermissions)
                                                                 throws com.liferay.portal.PortalException,
                                                                        com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFileShortcut

public static com.liferay.portal.kernel.json.JSONObject addFileShortcut(long folderId,
                                                                        long toFolderId,
                                                                        java.lang.String toName,
                                                                        java.lang.String[] communityPermissions,
                                                                        java.lang.String[] guestPermissions)
                                                                 throws com.liferay.portal.PortalException,
                                                                        com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteFileShortcut

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

getFileShortcut

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

updateFileShortcut

public static com.liferay.portal.kernel.json.JSONObject updateFileShortcut(long fileShortcutId,
                                                                           long folderId,
                                                                           long toFolderId,
                                                                           java.lang.String toName)
                                                                    throws com.liferay.portal.PortalException,
                                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException