Liferay 6.2-ce-ga5

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

java.lang.Object
  extended by com.liferay.portlet.dynamicdatamapping.service.http.DDMTemplateServiceHttp

public class DDMTemplateServiceHttp
extends 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.

See Also:
DDMTemplateServiceSoap, HttpPrincipal, DDMTemplateServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
DDMTemplateServiceHttp()
           
 
Method Summary
static DDMTemplate addTemplate(HttpPrincipal httpPrincipal, long groupId, long classNameId, long classPK, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, ServiceContext serviceContext)
           
static DDMTemplate addTemplate(HttpPrincipal httpPrincipal, long groupId, long classNameId, long classPK, String templateKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, boolean cacheable, boolean smallImage, String smallImageURL, File smallImageFile, ServiceContext serviceContext)
           
static DDMTemplate copyTemplate(HttpPrincipal httpPrincipal, long templateId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, ServiceContext serviceContext)
           
static DDMTemplate copyTemplate(HttpPrincipal httpPrincipal, long templateId, ServiceContext serviceContext)
           
static List<DDMTemplate> copyTemplates(HttpPrincipal httpPrincipal, long classNameId, long classPK, long newClassPK, String type, ServiceContext serviceContext)
           
static void deleteTemplate(HttpPrincipal httpPrincipal, long templateId)
           
static DDMTemplate fetchTemplate(HttpPrincipal httpPrincipal, long groupId, long classNameId, String templateKey)
           
static DDMTemplate getTemplate(HttpPrincipal httpPrincipal, long templateId)
           
static DDMTemplate getTemplate(HttpPrincipal httpPrincipal, long groupId, long classNameId, String templateKey)
           
static DDMTemplate getTemplate(HttpPrincipal httpPrincipal, long groupId, long classNameId, String templateKey, boolean includeGlobalTemplates)
           
static List<DDMTemplate> getTemplates(HttpPrincipal httpPrincipal, long groupId, long classNameId)
           
static List<DDMTemplate> getTemplates(HttpPrincipal httpPrincipal, long groupId, long classNameId, long classPK)
           
static List<DDMTemplate> getTemplates(HttpPrincipal httpPrincipal, long groupId, long classNameId, long classPK, String type)
           
static List<DDMTemplate> getTemplates(HttpPrincipal httpPrincipal, long groupId, long classNameId, long classPK, String type, String mode)
           
static List<DDMTemplate> getTemplatesByClassPK(HttpPrincipal httpPrincipal, long groupId, long classPK)
           
static List<DDMTemplate> getTemplatesByStructureClassNameId(HttpPrincipal httpPrincipal, long groupId, long structureClassNameId, int start, int end, OrderByComparator orderByComparator)
           
static int getTemplatesByStructureClassNameIdCount(HttpPrincipal httpPrincipal, long groupId, long structureClassNameId)
           
static List<DDMTemplate> search(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, String keywords, String type, String mode, int start, int end, OrderByComparator orderByComparator)
           
static List<DDMTemplate> search(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, String name, String description, String type, String mode, String language, boolean andOperator, int start, int end, OrderByComparator orderByComparator)
           
static List<DDMTemplate> search(HttpPrincipal httpPrincipal, long companyId, long groupId, long classNameId, long classPK, String keywords, String type, String mode, int start, int end, OrderByComparator orderByComparator)
           
static List<DDMTemplate> search(HttpPrincipal httpPrincipal, long companyId, long groupId, long classNameId, long classPK, String name, String description, String type, String mode, String language, boolean andOperator, int start, int end, OrderByComparator orderByComparator)
           
static int searchCount(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, String keywords, String type, String mode)
           
static int searchCount(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, String name, String description, String type, String mode, String language, boolean andOperator)
           
static int searchCount(HttpPrincipal httpPrincipal, long companyId, long groupId, long classNameId, long classPK, String keywords, String type, String mode)
           
static int searchCount(HttpPrincipal httpPrincipal, long companyId, long groupId, long classNameId, long classPK, String name, String description, String type, String mode, String language, boolean andOperator)
           
static DDMTemplate updateTemplate(HttpPrincipal httpPrincipal, long templateId, long classPK, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, boolean cacheable, boolean smallImage, String smallImageURL, File smallImageFile, 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 DDMTemplate addTemplate(HttpPrincipal httpPrincipal,
                                      long groupId,
                                      long classNameId,
                                      long classPK,
                                      Map<Locale,String> nameMap,
                                      Map<Locale,String> descriptionMap,
                                      String type,
                                      String mode,
                                      String language,
                                      String script,
                                      ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

addTemplate

public static DDMTemplate addTemplate(HttpPrincipal httpPrincipal,
                                      long groupId,
                                      long classNameId,
                                      long classPK,
                                      String templateKey,
                                      Map<Locale,String> nameMap,
                                      Map<Locale,String> descriptionMap,
                                      String type,
                                      String mode,
                                      String language,
                                      String script,
                                      boolean cacheable,
                                      boolean smallImage,
                                      String smallImageURL,
                                      File smallImageFile,
                                      ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

copyTemplate

public static DDMTemplate copyTemplate(HttpPrincipal httpPrincipal,
                                       long templateId,
                                       Map<Locale,String> nameMap,
                                       Map<Locale,String> descriptionMap,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

copyTemplate

public static DDMTemplate copyTemplate(HttpPrincipal httpPrincipal,
                                       long templateId,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

copyTemplates

public static List<DDMTemplate> copyTemplates(HttpPrincipal httpPrincipal,
                                              long classNameId,
                                              long classPK,
                                              long newClassPK,
                                              String type,
                                              ServiceContext serviceContext)
                                       throws PortalException,
                                              SystemException
Throws:
PortalException
SystemException

deleteTemplate

public static void deleteTemplate(HttpPrincipal httpPrincipal,
                                  long templateId)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

fetchTemplate

public static DDMTemplate fetchTemplate(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        long classNameId,
                                        String templateKey)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getTemplate

public static DDMTemplate getTemplate(HttpPrincipal httpPrincipal,
                                      long templateId)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

getTemplate

public static DDMTemplate getTemplate(HttpPrincipal httpPrincipal,
                                      long groupId,
                                      long classNameId,
                                      String templateKey)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

getTemplate

public static DDMTemplate getTemplate(HttpPrincipal httpPrincipal,
                                      long groupId,
                                      long classNameId,
                                      String templateKey,
                                      boolean includeGlobalTemplates)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

getTemplates

public static List<DDMTemplate> getTemplates(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             long classNameId)
                                      throws SystemException
Throws:
SystemException

getTemplates

public static List<DDMTemplate> getTemplates(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             long classNameId,
                                             long classPK)
                                      throws SystemException
Throws:
SystemException

getTemplates

public static List<DDMTemplate> getTemplates(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             long classNameId,
                                             long classPK,
                                             String type)
                                      throws SystemException
Throws:
SystemException

getTemplates

public static List<DDMTemplate> getTemplates(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             long classNameId,
                                             long classPK,
                                             String type,
                                             String mode)
                                      throws SystemException
Throws:
SystemException

getTemplatesByClassPK

public static List<DDMTemplate> getTemplatesByClassPK(HttpPrincipal httpPrincipal,
                                                      long groupId,
                                                      long classPK)
                                               throws SystemException
Throws:
SystemException

getTemplatesByStructureClassNameId

public static List<DDMTemplate> getTemplatesByStructureClassNameId(HttpPrincipal httpPrincipal,
                                                                   long groupId,
                                                                   long structureClassNameId,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator orderByComparator)
                                                            throws SystemException
Throws:
SystemException

getTemplatesByStructureClassNameIdCount

public static int getTemplatesByStructureClassNameIdCount(HttpPrincipal httpPrincipal,
                                                          long groupId,
                                                          long structureClassNameId)
                                                   throws SystemException
Throws:
SystemException

search

public static List<DDMTemplate> search(HttpPrincipal httpPrincipal,
                                       long companyId,
                                       long groupId,
                                       long classNameId,
                                       long classPK,
                                       String keywords,
                                       String type,
                                       String mode,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws SystemException
Throws:
SystemException

search

public static List<DDMTemplate> search(HttpPrincipal httpPrincipal,
                                       long companyId,
                                       long groupId,
                                       long classNameId,
                                       long classPK,
                                       String name,
                                       String description,
                                       String type,
                                       String mode,
                                       String language,
                                       boolean andOperator,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws SystemException
Throws:
SystemException

search

public static List<DDMTemplate> search(HttpPrincipal httpPrincipal,
                                       long companyId,
                                       long[] groupIds,
                                       long[] classNameIds,
                                       long[] classPKs,
                                       String keywords,
                                       String type,
                                       String mode,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws SystemException
Throws:
SystemException

search

public static List<DDMTemplate> search(HttpPrincipal httpPrincipal,
                                       long companyId,
                                       long[] groupIds,
                                       long[] classNameIds,
                                       long[] classPKs,
                                       String name,
                                       String description,
                                       String type,
                                       String mode,
                                       String language,
                                       boolean andOperator,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws SystemException
Throws:
SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              long groupId,
                              long classNameId,
                              long classPK,
                              String keywords,
                              String type,
                              String mode)
                       throws SystemException
Throws:
SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              long groupId,
                              long classNameId,
                              long classPK,
                              String name,
                              String description,
                              String type,
                              String mode,
                              String language,
                              boolean andOperator)
                       throws SystemException
Throws:
SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              long[] groupIds,
                              long[] classNameIds,
                              long[] classPKs,
                              String keywords,
                              String type,
                              String mode)
                       throws SystemException
Throws:
SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              long[] groupIds,
                              long[] classNameIds,
                              long[] classPKs,
                              String name,
                              String description,
                              String type,
                              String mode,
                              String language,
                              boolean andOperator)
                       throws SystemException
Throws:
SystemException

updateTemplate

public static DDMTemplate updateTemplate(HttpPrincipal httpPrincipal,
                                         long templateId,
                                         long classPK,
                                         Map<Locale,String> nameMap,
                                         Map<Locale,String> descriptionMap,
                                         String type,
                                         String mode,
                                         String language,
                                         String script,
                                         boolean cacheable,
                                         boolean smallImage,
                                         String smallImageURL,
                                         File smallImageFile,
                                         ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5