com.liferay.portlet.journal.service.http
Class JournalTemplateServiceHttp

java.lang.Object
  com.liferay.portlet.journal.service.http.JournalTemplateServiceHttp

public class JournalTemplateServiceHttp
extends Object

This class provides a HTTP utility for the JournalTemplateServiceUtil 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.

See Also:

JournalTemplateServiceSoap, HttpPrincipal, JournalTemplateServiceUtil

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

JournalTemplateServiceHttp()

Method Summary

static JournalTemplate	addTemplate(HttpPrincipal httpPrincipal, long groupId, String templateId, boolean autoTemplateId, String structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsl, boolean formatXsl, String langType, boolean cacheable, boolean smallImage, String smallImageURL, File smallFile, ServiceContext serviceContext)
static JournalTemplate	addTemplate(HttpPrincipal httpPrincipal, long groupId, String templateId, boolean autoTemplateId, String structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsl, boolean formatXsl, String langType, boolean cacheable, ServiceContext serviceContext)
static JournalTemplate	copyTemplate(HttpPrincipal httpPrincipal, long groupId, String oldTemplateId, String newTemplateId, boolean autoTemplateId)
static void	deleteTemplate(HttpPrincipal httpPrincipal, long groupId, String templateId)
static List<JournalTemplate>	getStructureTemplates(HttpPrincipal httpPrincipal, long groupId, String structureId)
static JournalTemplate	getTemplate(HttpPrincipal httpPrincipal, long groupId, String templateId)
static JournalTemplate	getTemplate(HttpPrincipal httpPrincipal, long groupId, String templateId, boolean includeGlobalTemplates)
static List<JournalTemplate>	search(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, String keywords, String structureId, String structureIdComparator, int start, int end, OrderByComparator obc)
static List<JournalTemplate>	search(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, String templateId, String structureId, String structureIdComparator, String name, String description, boolean andOperator, int start, int end, OrderByComparator obc)
static int	searchCount(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, String keywords, String structureId, String structureIdComparator)
static int	searchCount(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, String templateId, String structureId, String structureIdComparator, String name, String description, boolean andOperator)
static JournalTemplate	updateTemplate(HttpPrincipal httpPrincipal, long groupId, String templateId, String structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsl, boolean formatXsl, String langType, boolean cacheable, boolean smallImage, String smallImageURL, File smallFile, ServiceContext serviceContext)
static JournalTemplate	updateTemplate(HttpPrincipal httpPrincipal, long groupId, String templateId, String structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsl, boolean formatXsl, String langType, boolean cacheable, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

JournalTemplateServiceHttp

public JournalTemplateServiceHttp()

Method Detail

addTemplate

public static JournalTemplate addTemplate(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          String templateId,
                                          boolean autoTemplateId,
                                          String structureId,
                                          Map<Locale,String> nameMap,
                                          Map<Locale,String> descriptionMap,
                                          String xsl,
                                          boolean formatXsl,
                                          String langType,
                                          boolean cacheable,
                                          boolean smallImage,
                                          String smallImageURL,
                                          File smallFile,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

addTemplate

public static JournalTemplate addTemplate(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          String templateId,
                                          boolean autoTemplateId,
                                          String structureId,
                                          Map<Locale,String> nameMap,
                                          Map<Locale,String> descriptionMap,
                                          String xsl,
                                          boolean formatXsl,
                                          String langType,
                                          boolean cacheable,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

copyTemplate

public static JournalTemplate copyTemplate(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           String oldTemplateId,
                                           String newTemplateId,
                                           boolean autoTemplateId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

deleteTemplate

public static void deleteTemplate(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  String templateId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getStructureTemplates

public static List<JournalTemplate> getStructureTemplates(HttpPrincipal httpPrincipal,
                                                          long groupId,
                                                          String structureId)
                                                   throws SystemException

Throws:

SystemException

getTemplate

public static JournalTemplate getTemplate(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          String templateId)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getTemplate

public static JournalTemplate getTemplate(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          String templateId,
                                          boolean includeGlobalTemplates)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

search

public static List<JournalTemplate> search(HttpPrincipal httpPrincipal,
                                           long companyId,
                                           long[] groupIds,
                                           String keywords,
                                           String structureId,
                                           String structureIdComparator,
                                           int start,
                                           int end,
                                           OrderByComparator obc)
                                    throws SystemException

Throws:

SystemException

search

public static List<JournalTemplate> search(HttpPrincipal httpPrincipal,
                                           long companyId,
                                           long[] groupIds,
                                           String templateId,
                                           String structureId,
                                           String structureIdComparator,
                                           String name,
                                           String description,
                                           boolean andOperator,
                                           int start,
                                           int end,
                                           OrderByComparator obc)
                                    throws SystemException

Throws:

SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              long[] groupIds,
                              String keywords,
                              String structureId,
                              String structureIdComparator)
                       throws SystemException

Throws:

SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              long[] groupIds,
                              String templateId,
                              String structureId,
                              String structureIdComparator,
                              String name,
                              String description,
                              boolean andOperator)
                       throws SystemException

Throws:

SystemException

updateTemplate

public static JournalTemplate updateTemplate(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             String templateId,
                                             String structureId,
                                             Map<Locale,String> nameMap,
                                             Map<Locale,String> descriptionMap,
                                             String xsl,
                                             boolean formatXsl,
                                             String langType,
                                             boolean cacheable,
                                             boolean smallImage,
                                             String smallImageURL,
                                             File smallFile,
                                             ServiceContext serviceContext)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

updateTemplate

public static JournalTemplate updateTemplate(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             String templateId,
                                             String structureId,
                                             Map<Locale,String> nameMap,
                                             Map<Locale,String> descriptionMap,
                                             String xsl,
                                             boolean formatXsl,
                                             String langType,
                                             boolean cacheable,
                                             ServiceContext serviceContext)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException