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

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

public class DLFileEntryServiceJSON
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.DLFileEntryServiceUtil 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.documentlibrary.model.DLFileEntry, 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.documentlibrary.service.http.DLFileEntryJSONSerializer.

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:
DLFileEntryServiceUtil, DLFileEntryJSONSerializer

Constructor Summary
DLFileEntryServiceJSON()
           
 
Method Summary
static org.json.JSONObject addFileEntry(long folderId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String[] tagsEntries, java.lang.String extraSettings, byte[] byteArray, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static org.json.JSONObject addFileEntry(long folderId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String[] tagsEntries, java.lang.String extraSettings, byte[] byteArray, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static void deleteFileEntry(long folderId, java.lang.String name)
           
static void deleteFileEntry(long folderId, java.lang.String name, double version)
           
static void deleteFileEntryByTitle(long folderId, java.lang.String titleWithExtension)
           
static org.json.JSONArray getFileEntries(long folderId)
           
static org.json.JSONObject getFileEntry(long folderId, java.lang.String name)
           
static org.json.JSONObject getFileEntryByTitle(long folderId, java.lang.String titleWithExtension)
           
static void lockFileEntry(long folderId, java.lang.String name)
           
static void unlockFileEntry(long folderId, java.lang.String name)
           
static org.json.JSONObject updateFileEntry(long folderId, long newFolderId, java.lang.String name, java.lang.String sourceFileName, java.lang.String title, java.lang.String description, java.lang.String[] tagsEntries, java.lang.String extraSettings, byte[] byteArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLFileEntryServiceJSON

public DLFileEntryServiceJSON()
Method Detail

addFileEntry

public static org.json.JSONObject addFileEntry(long folderId,
                                               java.lang.String name,
                                               java.lang.String title,
                                               java.lang.String description,
                                               java.lang.String[] tagsEntries,
                                               java.lang.String extraSettings,
                                               byte[] byteArray,
                                               boolean addCommunityPermissions,
                                               boolean addGuestPermissions)
                                        throws java.rmi.RemoteException,
                                               com.liferay.portal.SystemException,
                                               com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addFileEntry

public static org.json.JSONObject addFileEntry(long folderId,
                                               java.lang.String name,
                                               java.lang.String title,
                                               java.lang.String description,
                                               java.lang.String[] tagsEntries,
                                               java.lang.String extraSettings,
                                               byte[] byteArray,
                                               java.lang.String[] communityPermissions,
                                               java.lang.String[] guestPermissions)
                                        throws java.rmi.RemoteException,
                                               com.liferay.portal.SystemException,
                                               com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteFileEntry

public static void deleteFileEntry(long folderId,
                                   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

deleteFileEntry

public static void deleteFileEntry(long folderId,
                                   java.lang.String name,
                                   double version)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteFileEntryByTitle

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

getFileEntries

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

getFileEntry

public static org.json.JSONObject getFileEntry(long folderId,
                                               java.lang.String name)
                                        throws java.rmi.RemoteException,
                                               com.liferay.portal.SystemException,
                                               com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getFileEntryByTitle

public static org.json.JSONObject getFileEntryByTitle(long folderId,
                                                      java.lang.String titleWithExtension)
                                               throws java.rmi.RemoteException,
                                                      com.liferay.portal.SystemException,
                                                      com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

lockFileEntry

public static void lockFileEntry(long folderId,
                                 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

unlockFileEntry

public static void unlockFileEntry(long folderId,
                                   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

updateFileEntry

public static org.json.JSONObject updateFileEntry(long folderId,
                                                  long newFolderId,
                                                  java.lang.String name,
                                                  java.lang.String sourceFileName,
                                                  java.lang.String title,
                                                  java.lang.String description,
                                                  java.lang.String[] tagsEntries,
                                                  java.lang.String extraSettings,
                                                  byte[] byteArray)
                                           throws com.liferay.portal.SystemException,
                                                  com.liferay.portal.PortalException,
                                                  java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException