com.liferay.portlet.dynamicdatamapping.service.http

Class DDMTemplateServiceHttp

java.lang.Object

com.liferay.portlet.dynamicdatamapping.service.http.DDMTemplateServiceHttp

public class DDMTemplateServiceHttp
extends java.lang.Object

Provides the HTTP utility for the DDMTemplateServiceUtil 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:

DDMTemplateServiceSoap, HttpPrincipal, DDMTemplateServiceUtil

Generated:

Constructor Summary

Constructors

Constructor and Description
DDMTemplateServiceHttp()

Method Summary

Methods

Modifier and Type	Method and Description
static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate	addTemplate(HttpPrincipal httpPrincipal, long groupId, long classNameId, long classPK, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String type, java.lang.String mode, java.lang.String language, java.lang.String script, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate	addTemplate(HttpPrincipal httpPrincipal, long groupId, long classNameId, long classPK, java.lang.String templateKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String type, java.lang.String mode, java.lang.String language, java.lang.String script, boolean cacheable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallImageFile, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate	copyTemplate(HttpPrincipal httpPrincipal, long templateId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate	copyTemplate(HttpPrincipal httpPrincipal, long templateId, com.liferay.portal.service.ServiceContext serviceContext)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	copyTemplates(HttpPrincipal httpPrincipal, long classNameId, long classPK, long newClassPK, java.lang.String type, com.liferay.portal.service.ServiceContext serviceContext)
static void	deleteTemplate(HttpPrincipal httpPrincipal, long templateId)
static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate	fetchTemplate(HttpPrincipal httpPrincipal, long groupId, long classNameId, java.lang.String templateKey)
static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate	getTemplate(HttpPrincipal httpPrincipal, long templateId)
static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate	getTemplate(HttpPrincipal httpPrincipal, long groupId, long classNameId, java.lang.String templateKey)
static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate	getTemplate(HttpPrincipal httpPrincipal, long groupId, long classNameId, java.lang.String templateKey, boolean includeGlobalTemplates)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	getTemplates(HttpPrincipal httpPrincipal, long groupId, long classNameId)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	getTemplates(HttpPrincipal httpPrincipal, long groupId, long classNameId, long classPK)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	getTemplates(HttpPrincipal httpPrincipal, long groupId, long classNameId, long classPK, java.lang.String type)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	getTemplates(HttpPrincipal httpPrincipal, long groupId, long classNameId, long classPK, java.lang.String type, java.lang.String mode)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	getTemplatesByClassPK(HttpPrincipal httpPrincipal, long groupId, long classPK)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	getTemplatesByStructureClassNameId(HttpPrincipal httpPrincipal, long groupId, long structureClassNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
static int	getTemplatesByStructureClassNameIdCount(HttpPrincipal httpPrincipal, long groupId, long structureClassNameId)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	search(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, java.lang.String keywords, java.lang.String type, java.lang.String mode, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	search(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	search(HttpPrincipal httpPrincipal, long companyId, long groupId, long classNameId, long classPK, java.lang.String keywords, java.lang.String type, java.lang.String mode, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate>	search(HttpPrincipal httpPrincipal, long companyId, long groupId, long classNameId, long classPK, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
static int	searchCount(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, java.lang.String keywords, java.lang.String type, java.lang.String mode)
static int	searchCount(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, boolean andOperator)
static int	searchCount(HttpPrincipal httpPrincipal, long companyId, long groupId, long classNameId, long classPK, java.lang.String keywords, java.lang.String type, java.lang.String mode)
static int	searchCount(HttpPrincipal httpPrincipal, long companyId, long groupId, long classNameId, long classPK, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, boolean andOperator)
static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate	updateTemplate(HttpPrincipal httpPrincipal, long templateId, long classPK, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String type, java.lang.String mode, java.lang.String language, java.lang.String script, boolean cacheable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallImageFile, 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

DDMTemplateServiceHttp

public DDMTemplateServiceHttp()

Method Detail

addTemplate

public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate addTemplate(HttpPrincipal httpPrincipal,
                                                                   long groupId,
                                                                   long classNameId,
                                                                   long classPK,
                                                                   java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                                   java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                                   java.lang.String type,
                                                                   java.lang.String mode,
                                                                   java.lang.String language,
                                                                   java.lang.String script,
                                                                   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

addTemplate

public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate addTemplate(HttpPrincipal httpPrincipal,
                                                                   long groupId,
                                                                   long classNameId,
                                                                   long classPK,
                                                                   java.lang.String templateKey,
                                                                   java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                                   java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                                   java.lang.String type,
                                                                   java.lang.String mode,
                                                                   java.lang.String language,
                                                                   java.lang.String script,
                                                                   boolean cacheable,
                                                                   boolean smallImage,
                                                                   java.lang.String smallImageURL,
                                                                   java.io.File smallImageFile,
                                                                   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

copyTemplate

public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate copyTemplate(HttpPrincipal httpPrincipal,
                                                                    long templateId,
                                                                    java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                                    java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                                    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

copyTemplate

public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate copyTemplate(HttpPrincipal httpPrincipal,
                                                                    long templateId,
                                                                    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

copyTemplates

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> copyTemplates(HttpPrincipal httpPrincipal,
                                                                                     long classNameId,
                                                                                     long classPK,
                                                                                     long newClassPK,
                                                                                     java.lang.String type,
                                                                                     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

deleteTemplate

public static void deleteTemplate(HttpPrincipal httpPrincipal,
                  long templateId)
                           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

fetchTemplate

public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate fetchTemplate(HttpPrincipal httpPrincipal,
                                                                     long groupId,
                                                                     long classNameId,
                                                                     java.lang.String templateKey)
                                                                              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

getTemplate

public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getTemplate(HttpPrincipal httpPrincipal,
                                                                   long templateId)
                                                                            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

getTemplate

public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getTemplate(HttpPrincipal httpPrincipal,
                                                                   long groupId,
                                                                   long classNameId,
                                                                   java.lang.String templateKey)
                                                                            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

getTemplate

public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getTemplate(HttpPrincipal httpPrincipal,
                                                                   long groupId,
                                                                   long classNameId,
                                                                   java.lang.String templateKey,
                                                                   boolean includeGlobalTemplates)
                                                                            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

getTemplates

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(HttpPrincipal httpPrincipal,
                                                                                    long groupId,
                                                                                    long classNameId)
                                                                                             throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getTemplates

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(HttpPrincipal httpPrincipal,
                                                                                    long groupId,
                                                                                    long classNameId,
                                                                                    long classPK)
                                                                                             throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getTemplates

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(HttpPrincipal httpPrincipal,
                                                                                    long groupId,
                                                                                    long classNameId,
                                                                                    long classPK,
                                                                                    java.lang.String type)
                                                                                             throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getTemplates

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(HttpPrincipal httpPrincipal,
                                                                                    long groupId,
                                                                                    long classNameId,
                                                                                    long classPK,
                                                                                    java.lang.String type,
                                                                                    java.lang.String mode)
                                                                                             throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getTemplatesByClassPK

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplatesByClassPK(HttpPrincipal httpPrincipal,
                                                                                             long groupId,
                                                                                             long classPK)
                                                                                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getTemplatesByStructureClassNameId

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplatesByStructureClassNameId(HttpPrincipal httpPrincipal,
                                                                                                          long groupId,
                                                                                                          long structureClassNameId,
                                                                                                          int start,
                                                                                                          int end,
                                                                                                          com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
                                                                                                                   throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getTemplatesByStructureClassNameIdCount

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

Throws:

com.liferay.portal.kernel.exception.SystemException

search

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(HttpPrincipal httpPrincipal,
                                                                              long companyId,
                                                                              long groupId,
                                                                              long classNameId,
                                                                              long classPK,
                                                                              java.lang.String keywords,
                                                                              java.lang.String type,
                                                                              java.lang.String mode,
                                                                              int start,
                                                                              int end,
                                                                              com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
                                                                                       throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

search

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(HttpPrincipal httpPrincipal,
                                                                              long companyId,
                                                                              long groupId,
                                                                              long classNameId,
                                                                              long classPK,
                                                                              java.lang.String name,
                                                                              java.lang.String description,
                                                                              java.lang.String type,
                                                                              java.lang.String mode,
                                                                              java.lang.String language,
                                                                              boolean andOperator,
                                                                              int start,
                                                                              int end,
                                                                              com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
                                                                                       throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

search

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(HttpPrincipal httpPrincipal,
                                                                              long companyId,
                                                                              long[] groupIds,
                                                                              long[] classNameIds,
                                                                              long[] classPKs,
                                                                              java.lang.String keywords,
                                                                              java.lang.String type,
                                                                              java.lang.String mode,
                                                                              int start,
                                                                              int end,
                                                                              com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
                                                                                       throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

search

public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(HttpPrincipal httpPrincipal,
                                                                              long companyId,
                                                                              long[] groupIds,
                                                                              long[] classNameIds,
                                                                              long[] classPKs,
                                                                              java.lang.String name,
                                                                              java.lang.String description,
                                                                              java.lang.String type,
                                                                              java.lang.String mode,
                                                                              java.lang.String language,
                                                                              boolean andOperator,
                                                                              int start,
                                                                              int end,
                                                                              com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
                                                                                       throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
              long companyId,
              long groupId,
              long classNameId,
              long classPK,
              java.lang.String keywords,
              java.lang.String type,
              java.lang.String mode)
                       throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
              long companyId,
              long groupId,
              long classNameId,
              long classPK,
              java.lang.String name,
              java.lang.String description,
              java.lang.String type,
              java.lang.String mode,
              java.lang.String language,
              boolean andOperator)
                       throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
              long companyId,
              long[] groupIds,
              long[] classNameIds,
              long[] classPKs,
              java.lang.String keywords,
              java.lang.String type,
              java.lang.String mode)
                       throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
              long companyId,
              long[] groupIds,
              long[] classNameIds,
              long[] classPKs,
              java.lang.String name,
              java.lang.String description,
              java.lang.String type,
              java.lang.String mode,
              java.lang.String language,
              boolean andOperator)
                       throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

updateTemplate

public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateTemplate(HttpPrincipal httpPrincipal,
                                                                      long templateId,
                                                                      long classPK,
                                                                      java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                                      java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                                      java.lang.String type,
                                                                      java.lang.String mode,
                                                                      java.lang.String language,
                                                                      java.lang.String script,
                                                                      boolean cacheable,
                                                                      boolean smallImage,
                                                                      java.lang.String smallImageURL,
                                                                      java.io.File smallImageFile,
                                                                      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