com.liferay.portlet.journal.service.http

Class JournalFolderServiceHttp

java.lang.Object

com.liferay.portlet.journal.service.http.JournalFolderServiceHttp

public class JournalFolderServiceHttp
extends java.lang.Object

Provides the HTTP utility for the JournalFolderServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it requires an additional HttpPrincipal parameter.

The benefits of using the HTTP utility is that it is fast and allows for tunneling without the cost of serializing to text. The drawback is that it only works with Java.

Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The HTTP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

JournalFolderServiceSoap, HttpPrincipal, JournalFolderServiceUtil

Generated:

Constructor Summary

Constructors

Constructor and Description
JournalFolderServiceHttp()

Method Summary

Methods

Modifier and Type	Method and Description
static com.liferay.portlet.journal.model.JournalFolder	addFolder(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, java.lang.String name, java.lang.String description, com.liferay.portal.service.ServiceContext serviceContext)
static void	deleteFolder(HttpPrincipal httpPrincipal, long folderId)
static void	deleteFolder(HttpPrincipal httpPrincipal, long folderId, boolean includeTrashedEntries)
static com.liferay.portlet.journal.model.JournalFolder	fetchFolder(HttpPrincipal httpPrincipal, long folderId)
static com.liferay.portlet.journal.model.JournalFolder	getFolder(HttpPrincipal httpPrincipal, long folderId)
static java.util.List<java.lang.Long>	getFolderIds(HttpPrincipal httpPrincipal, long groupId, long folderId)
static java.util.List<com.liferay.portlet.journal.model.JournalFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId)
static java.util.List<com.liferay.portlet.journal.model.JournalFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId)
static java.util.List<com.liferay.portlet.journal.model.JournalFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, int status)
static java.util.List<com.liferay.portlet.journal.model.JournalFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, int start, int end)
static java.util.List<com.liferay.portlet.journal.model.JournalFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, int status, int start, int end)
static java.util.List<java.lang.Object>	getFoldersAndArticles(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
static java.util.List<java.lang.Object>	getFoldersAndArticles(HttpPrincipal httpPrincipal, long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
static java.util.List<java.lang.Object>	getFoldersAndArticles(HttpPrincipal httpPrincipal, long groupId, long userId, long folderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
static int	getFoldersAndArticlesCount(HttpPrincipal httpPrincipal, long groupId, java.util.List<java.lang.Long> folderIds, int status)
static int	getFoldersAndArticlesCount(HttpPrincipal httpPrincipal, long groupId, long folderId)
static int	getFoldersAndArticlesCount(HttpPrincipal httpPrincipal, long groupId, long folderId, int status)
static int	getFoldersAndArticlesCount(HttpPrincipal httpPrincipal, long groupId, long userId, long folderId, int status)
static int	getFoldersCount(HttpPrincipal httpPrincipal, long groupId, long parentFolderId)
static int	getFoldersCount(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, int status)
static void	getSubfolderIds(HttpPrincipal httpPrincipal, java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
static void	getSubfolderIds(HttpPrincipal httpPrincipal, java.util.List<java.lang.Long> folderIds, long groupId, long folderId, boolean recurse)
static java.util.List<java.lang.Long>	getSubfolderIds(HttpPrincipal httpPrincipal, long groupId, long folderId, boolean recurse)
static com.liferay.portlet.journal.model.JournalFolder	moveFolder(HttpPrincipal httpPrincipal, long folderId, long parentFolderId, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.journal.model.JournalFolder	moveFolderFromTrash(HttpPrincipal httpPrincipal, long folderId, long parentFolderId, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.journal.model.JournalFolder	moveFolderToTrash(HttpPrincipal httpPrincipal, long folderId)
static void	restoreFolderFromTrash(HttpPrincipal httpPrincipal, long folderId)
static com.liferay.portlet.journal.model.JournalFolder	updateFolder(HttpPrincipal httpPrincipal, long folderId, long parentFolderId, java.lang.String name, java.lang.String description, boolean mergeWithParentFolder, com.liferay.portal.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JournalFolderServiceHttp

public JournalFolderServiceHttp()

Method Detail

addFolder

public static com.liferay.portlet.journal.model.JournalFolder addFolder(HttpPrincipal httpPrincipal,
                                                        long groupId,
                                                        long parentFolderId,
                                                        java.lang.String name,
                                                        java.lang.String description,
                                                        com.liferay.portal.service.ServiceContext serviceContext)
                                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                                        com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deleteFolder

public static void deleteFolder(HttpPrincipal httpPrincipal,
                long folderId)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deleteFolder

public static void deleteFolder(HttpPrincipal httpPrincipal,
                long folderId,
                boolean includeTrashedEntries)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

fetchFolder

public static com.liferay.portlet.journal.model.JournalFolder fetchFolder(HttpPrincipal httpPrincipal,
                                                          long folderId)
                                                                   throws com.liferay.portal.kernel.exception.PortalException,
                                                                          com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFolder

public static com.liferay.portlet.journal.model.JournalFolder getFolder(HttpPrincipal httpPrincipal,
                                                        long folderId)
                                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                                        com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFolderIds

public static java.util.List<java.lang.Long> getFolderIds(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          long folderId)
                                                   throws com.liferay.portal.kernel.exception.PortalException,
                                                          com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.journal.model.JournalFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                         long groupId)
                                                                                  throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.journal.model.JournalFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                         long groupId,
                                                                         long parentFolderId)
                                                                                  throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.journal.model.JournalFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                         long groupId,
                                                                         long parentFolderId,
                                                                         int status)
                                                                                  throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.journal.model.JournalFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                         long groupId,
                                                                         long parentFolderId,
                                                                         int start,
                                                                         int end)
                                                                                  throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.journal.model.JournalFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                         long groupId,
                                                                         long parentFolderId,
                                                                         int status,
                                                                         int start,
                                                                         int end)
                                                                                  throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndArticles

public static java.util.List<java.lang.Object> getFoldersAndArticles(HttpPrincipal httpPrincipal,
                                                     long groupId,
                                                     long folderId,
                                                     int status,
                                                     int start,
                                                     int end,
                                                     com.liferay.portal.kernel.util.OrderByComparator obc)
                                                              throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndArticles

public static java.util.List<java.lang.Object> getFoldersAndArticles(HttpPrincipal httpPrincipal,
                                                     long groupId,
                                                     long folderId,
                                                     int start,
                                                     int end,
                                                     com.liferay.portal.kernel.util.OrderByComparator obc)
                                                              throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndArticles

public static java.util.List<java.lang.Object> getFoldersAndArticles(HttpPrincipal httpPrincipal,
                                                     long groupId,
                                                     long userId,
                                                     long folderId,
                                                     int status,
                                                     int start,
                                                     int end,
                                                     com.liferay.portal.kernel.util.OrderByComparator obc)
                                                              throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndArticlesCount

public static int getFoldersAndArticlesCount(HttpPrincipal httpPrincipal,
                             long groupId,
                             java.util.List<java.lang.Long> folderIds,
                             int status)
                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndArticlesCount

public static int getFoldersAndArticlesCount(HttpPrincipal httpPrincipal,
                             long groupId,
                             long folderId)
                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndArticlesCount

public static int getFoldersAndArticlesCount(HttpPrincipal httpPrincipal,
                             long groupId,
                             long folderId,
                             int status)
                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndArticlesCount

public static int getFoldersAndArticlesCount(HttpPrincipal httpPrincipal,
                             long groupId,
                             long userId,
                             long folderId,
                             int status)
                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersCount

public static int getFoldersCount(HttpPrincipal httpPrincipal,
                  long groupId,
                  long parentFolderId)
                           throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersCount

public static int getFoldersCount(HttpPrincipal httpPrincipal,
                  long groupId,
                  long parentFolderId,
                  int status)
                           throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getSubfolderIds

public static void getSubfolderIds(HttpPrincipal httpPrincipal,
                   java.util.List<java.lang.Long> folderIds,
                   long groupId,
                   long folderId)
                            throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getSubfolderIds

public static void getSubfolderIds(HttpPrincipal httpPrincipal,
                   java.util.List<java.lang.Long> folderIds,
                   long groupId,
                   long folderId,
                   boolean recurse)
                            throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getSubfolderIds

public static java.util.List<java.lang.Long> getSubfolderIds(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             long folderId,
                                             boolean recurse)
                                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

moveFolder

public static com.liferay.portlet.journal.model.JournalFolder moveFolder(HttpPrincipal httpPrincipal,
                                                         long folderId,
                                                         long parentFolderId,
                                                         com.liferay.portal.service.ServiceContext serviceContext)
                                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                                         com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

moveFolderFromTrash

public static com.liferay.portlet.journal.model.JournalFolder moveFolderFromTrash(HttpPrincipal httpPrincipal,
                                                                  long folderId,
                                                                  long parentFolderId,
                                                                  com.liferay.portal.service.ServiceContext serviceContext)
                                                                           throws com.liferay.portal.kernel.exception.PortalException,
                                                                                  com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

moveFolderToTrash

public static com.liferay.portlet.journal.model.JournalFolder moveFolderToTrash(HttpPrincipal httpPrincipal,
                                                                long folderId)
                                                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

restoreFolderFromTrash

public static void restoreFolderFromTrash(HttpPrincipal httpPrincipal,
                          long folderId)
                                   throws com.liferay.portal.kernel.exception.PortalException,
                                          com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

updateFolder

public static com.liferay.portlet.journal.model.JournalFolder updateFolder(HttpPrincipal httpPrincipal,
                                                           long folderId,
                                                           long parentFolderId,
                                                           java.lang.String name,
                                                           java.lang.String description,
                                                           boolean mergeWithParentFolder,
                                                           com.liferay.portal.service.ServiceContext serviceContext)
                                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                                           com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException