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 com.liferay.portal.kernel.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.documentlibrary.model.DLFileEntry, 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.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 com.liferay.portal.kernel.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[] bytes, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static com.liferay.portal.kernel.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[] bytes, 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 com.liferay.portal.kernel.json.JSONArray getFileEntries(long folderId)
           
static com.liferay.portal.kernel.json.JSONObject getFileEntry(long folderId, java.lang.String name)
           
static com.liferay.portal.kernel.json.JSONObject getFileEntryByTitle(long folderId, java.lang.String titleWithExtension)
           
static boolean hasFileEntryLock(long folderId, java.lang.String name)
           
static com.liferay.lock.model.Lock lockFileEntry(long folderId, java.lang.String name)
           
static com.liferay.lock.model.Lock lockFileEntry(long folderId, java.lang.String name, java.lang.String owner, long expirationTime)
           
static com.liferay.lock.model.Lock refreshFileEntryLock(java.lang.String lockUuid, long expirationTime)
           
static void unlockFileEntry(long folderId, java.lang.String name)
           
static void unlockFileEntry(long folderId, java.lang.String name, java.lang.String lockUuid)
           
static com.liferay.portal.kernel.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[] bytes)
           
static boolean verifyFileEntryLock(long folderId, java.lang.String name, java.lang.String lockUuid)
           
 
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 com.liferay.portal.kernel.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[] bytes,
                                                                     boolean addCommunityPermissions,
                                                                     boolean addGuestPermissions)
                                                              throws com.liferay.portal.PortalException,
                                                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFileEntry

public static com.liferay.portal.kernel.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[] bytes,
                                                                     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

deleteFileEntry

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

deleteFileEntry

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

deleteFileEntryByTitle

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

getFileEntries

public static com.liferay.portal.kernel.json.JSONArray getFileEntries(long folderId)
                                                               throws com.liferay.portal.PortalException,
                                                                      com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFileEntry

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

getFileEntryByTitle

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

hasFileEntryLock

public static boolean hasFileEntryLock(long folderId,
                                       java.lang.String name)
                                throws com.liferay.portal.PortalException
Throws:
com.liferay.portal.PortalException

lockFileEntry

public static com.liferay.lock.model.Lock lockFileEntry(long folderId,
                                                        java.lang.String name)
                                                 throws com.liferay.portal.PortalException,
                                                        com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

lockFileEntry

public static com.liferay.lock.model.Lock lockFileEntry(long folderId,
                                                        java.lang.String name,
                                                        java.lang.String owner,
                                                        long expirationTime)
                                                 throws com.liferay.portal.PortalException,
                                                        com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

refreshFileEntryLock

public static com.liferay.lock.model.Lock refreshFileEntryLock(java.lang.String lockUuid,
                                                               long expirationTime)
                                                        throws com.liferay.portal.PortalException
Throws:
com.liferay.portal.PortalException

unlockFileEntry

public static void unlockFileEntry(long folderId,
                                   java.lang.String name)

unlockFileEntry

public static void unlockFileEntry(long folderId,
                                   java.lang.String name,
                                   java.lang.String lockUuid)
                            throws com.liferay.portal.PortalException
Throws:
com.liferay.portal.PortalException

updateFileEntry

public static com.liferay.portal.kernel.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[] bytes)
                                                                 throws com.liferay.portal.PortalException,
                                                                        com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

verifyFileEntryLock

public static boolean verifyFileEntryLock(long folderId,
                                          java.lang.String name,
                                          java.lang.String lockUuid)
                                   throws com.liferay.portal.PortalException
Throws:
com.liferay.portal.PortalException