com.liferay.portlet.documentlibrary.service.http
Class DLFolderServiceJSON
java.lang.Object
com.liferay.portlet.documentlibrary.service.http.DLFolderServiceJSON
public class DLFolderServiceJSON
- 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.DLFolderServiceUtil
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.DLFolder
,
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.DLFolderJSONSerializer
.
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:
DLFolderServiceUtil
,
DLFolderJSONSerializer
Method Summary |
static com.liferay.portal.kernel.json.JSONObject |
addFolder(long plid,
long parentFolderId,
java.lang.String name,
java.lang.String description,
boolean addCommunityPermissions,
boolean addGuestPermissions)
|
static com.liferay.portal.kernel.json.JSONObject |
addFolder(long plid,
long parentFolderId,
java.lang.String name,
java.lang.String description,
java.lang.String[] communityPermissions,
java.lang.String[] guestPermissions)
|
static com.liferay.portal.kernel.json.JSONObject |
copyFolder(long plid,
long sourceFolderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
boolean addCommunityPermissions,
boolean addGuestPermissions)
|
static void |
deleteFolder(long folderId)
|
static void |
deleteFolder(long groupId,
long parentFolderId,
java.lang.String name)
|
static com.liferay.portal.kernel.json.JSONObject |
getFolder(long folderId)
|
static com.liferay.portal.kernel.json.JSONObject |
getFolder(long groupId,
long parentFolderId,
java.lang.String name)
|
static long |
getFolderId(long groupId,
long parentFolderId,
java.lang.String name)
|
static com.liferay.portal.kernel.json.JSONArray |
getFolders(long groupId,
long parentFolderId)
|
static void |
reIndexSearch(long companyId)
|
static com.liferay.portal.kernel.json.JSONObject |
updateFolder(long folderId,
long parentFolderId,
java.lang.String name,
java.lang.String description)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DLFolderServiceJSON
public DLFolderServiceJSON()
addFolder
public static com.liferay.portal.kernel.json.JSONObject addFolder(long plid,
long parentFolderId,
java.lang.String name,
java.lang.String description,
boolean addCommunityPermissions,
boolean addGuestPermissions)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
addFolder
public static com.liferay.portal.kernel.json.JSONObject addFolder(long plid,
long parentFolderId,
java.lang.String name,
java.lang.String description,
java.lang.String[] communityPermissions,
java.lang.String[] guestPermissions)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
copyFolder
public static com.liferay.portal.kernel.json.JSONObject copyFolder(long plid,
long sourceFolderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
boolean addCommunityPermissions,
boolean addGuestPermissions)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException
deleteFolder
public static void deleteFolder(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
deleteFolder
public static void deleteFolder(long groupId,
long parentFolderId,
java.lang.String name)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getFolder
public static com.liferay.portal.kernel.json.JSONObject getFolder(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
getFolder
public static com.liferay.portal.kernel.json.JSONObject getFolder(long groupId,
long parentFolderId,
java.lang.String name)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getFolderId
public static long getFolderId(long groupId,
long parentFolderId,
java.lang.String name)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getFolders
public static com.liferay.portal.kernel.json.JSONArray getFolders(long groupId,
long parentFolderId)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
reIndexSearch
public static void reIndexSearch(long companyId)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
updateFolder
public static com.liferay.portal.kernel.json.JSONObject updateFolder(long folderId,
long parentFolderId,
java.lang.String name,
java.lang.String description)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException