Liferay 6.2.0-ce-m3

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

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

public class DDMTemplateServiceSoap
extends Object

This class provides a SOAP 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 is difficult for SOAP to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a List, that is translated to an array of DDMTemplateSoap. If the method in the service utility returns a DDMTemplate, that is translated to a DDMTemplateSoap. Methods that SOAP cannot safely wire are skipped.

The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).

You can see a list of services at http://localhost:8080/api/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

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

Constructor Summary
DDMTemplateServiceSoap()
           
 
Method Summary
static DDMTemplateSoap addTemplate(long groupId, long classNameId, long classPK, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, String type, String mode, String language, String script, ServiceContext serviceContext)
           
static DDMTemplateSoap copyTemplate(long templateId, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, ServiceContext serviceContext)
           
static DDMTemplateSoap[] copyTemplates(long classNameId, long classPK, long newClassPK, String type, ServiceContext serviceContext)
           
static void deleteTemplate(long templateId)
           
static DDMTemplateSoap fetchTemplate(long groupId, String templateKey)
           
static DDMTemplateSoap getTemplate(long templateId)
           
static DDMTemplateSoap getTemplate(long groupId, String templateKey)
           
static DDMTemplateSoap getTemplate(long groupId, String templateKey, boolean includeGlobalTemplates)
           
static DDMTemplateSoap[] getTemplates(long groupId, long classNameId)
           
static DDMTemplateSoap[] getTemplates(long groupId, long classNameId, long classPK)
           
static DDMTemplateSoap[] getTemplates(long classNameId, long classPK, String type, String mode)
           
static DDMTemplateSoap[] search(long companyId, long[] groupIds, long[] classNameIds, long classPK, String keywords, String type, String mode, int start, int end, OrderByComparator orderByComparator)
           
static DDMTemplateSoap[] search(long companyId, long[] groupIds, long[] classNameIds, long classPK, String name, String description, String type, String mode, String language, boolean andOperator, int start, int end, OrderByComparator orderByComparator)
           
static DDMTemplateSoap[] search(long companyId, long groupId, long classNameId, long classPK, String keywords, String type, String mode, int start, int end, OrderByComparator orderByComparator)
           
static DDMTemplateSoap[] search(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(long companyId, long[] groupIds, long[] classNameIds, long classPK, String keywords, String type, String mode)
           
static int searchCount(long companyId, long[] groupIds, long[] classNameIds, long classPK, String name, String description, String type, String mode, String language, boolean andOperator)
           
static int searchCount(long companyId, long groupId, long classNameId, long classPK, String keywords, String type, String mode)
           
static int searchCount(long companyId, long groupId, long classNameId, long classPK, String name, String description, String type, String mode, String language, boolean andOperator)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DDMTemplateServiceSoap

public DDMTemplateServiceSoap()
Method Detail

addTemplate

public static DDMTemplateSoap addTemplate(long groupId,
                                          long classNameId,
                                          long classPK,
                                          String[] nameMapLanguageIds,
                                          String[] nameMapValues,
                                          String[] descriptionMapLanguageIds,
                                          String[] descriptionMapValues,
                                          String type,
                                          String mode,
                                          String language,
                                          String script,
                                          ServiceContext serviceContext)
                                   throws RemoteException
Throws:
RemoteException

copyTemplate

public static DDMTemplateSoap copyTemplate(long templateId,
                                           String[] nameMapLanguageIds,
                                           String[] nameMapValues,
                                           String[] descriptionMapLanguageIds,
                                           String[] descriptionMapValues,
                                           ServiceContext serviceContext)
                                    throws RemoteException
Throws:
RemoteException

copyTemplates

public static DDMTemplateSoap[] copyTemplates(long classNameId,
                                              long classPK,
                                              long newClassPK,
                                              String type,
                                              ServiceContext serviceContext)
                                       throws RemoteException
Throws:
RemoteException

deleteTemplate

public static void deleteTemplate(long templateId)
                           throws RemoteException
Throws:
RemoteException

fetchTemplate

public static DDMTemplateSoap fetchTemplate(long groupId,
                                            String templateKey)
                                     throws RemoteException
Throws:
RemoteException

getTemplate

public static DDMTemplateSoap getTemplate(long templateId)
                                   throws RemoteException
Throws:
RemoteException

getTemplate

public static DDMTemplateSoap getTemplate(long groupId,
                                          String templateKey)
                                   throws RemoteException
Throws:
RemoteException

getTemplate

public static DDMTemplateSoap getTemplate(long groupId,
                                          String templateKey,
                                          boolean includeGlobalTemplates)
                                   throws RemoteException
Throws:
RemoteException

getTemplates

public static DDMTemplateSoap[] getTemplates(long groupId,
                                             long classNameId)
                                      throws RemoteException
Throws:
RemoteException

getTemplates

public static DDMTemplateSoap[] getTemplates(long groupId,
                                             long classNameId,
                                             long classPK)
                                      throws RemoteException
Throws:
RemoteException

getTemplates

public static DDMTemplateSoap[] getTemplates(long classNameId,
                                             long classPK,
                                             String type,
                                             String mode)
                                      throws RemoteException
Throws:
RemoteException

search

public static DDMTemplateSoap[] search(long companyId,
                                       long groupId,
                                       long classNameId,
                                       long classPK,
                                       String keywords,
                                       String type,
                                       String mode,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws RemoteException
Throws:
RemoteException

search

public static DDMTemplateSoap[] search(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 RemoteException
Throws:
RemoteException

search

public static DDMTemplateSoap[] search(long companyId,
                                       long[] groupIds,
                                       long[] classNameIds,
                                       long classPK,
                                       String keywords,
                                       String type,
                                       String mode,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws RemoteException
Throws:
RemoteException

search

public static DDMTemplateSoap[] search(long companyId,
                                       long[] groupIds,
                                       long[] classNameIds,
                                       long classPK,
                                       String name,
                                       String description,
                                       String type,
                                       String mode,
                                       String language,
                                       boolean andOperator,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws RemoteException
Throws:
RemoteException

searchCount

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

searchCount

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

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long[] classNameIds,
                              long classPK,
                              String keywords,
                              String type,
                              String mode)
                       throws RemoteException
Throws:
RemoteException

searchCount

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

Liferay 6.2.0-ce-m3