Liferay 6.1.2-ce-ga3

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

java.lang.Object
  extended by com.liferay.portlet.journal.service.http.JournalTemplateServiceSoap

public class JournalTemplateServiceSoap
extends Object

This class provides a SOAP 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 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 JournalTemplateSoap. If the method in the service utility returns a JournalTemplate, that is translated to a JournalTemplateSoap. 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/secure/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:
JournalTemplateServiceHttp, JournalTemplateSoap, JournalTemplateServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
JournalTemplateServiceSoap()
           
 
Method Summary
static JournalTemplateSoap addTemplate(long groupId, String templateId, boolean autoTemplateId, String structureId, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, String xsl, boolean formatXsl, String langType, boolean cacheable, ServiceContext serviceContext)
           
static JournalTemplateSoap copyTemplate(long groupId, String oldTemplateId, String newTemplateId, boolean autoTemplateId)
           
static void deleteTemplate(long groupId, String templateId)
           
static JournalTemplateSoap[] getStructureTemplates(long groupId, String structureId)
           
static JournalTemplateSoap getTemplate(long groupId, String templateId)
           
static JournalTemplateSoap getTemplate(long groupId, String templateId, boolean includeGlobalTemplates)
           
static JournalTemplateSoap[] search(long companyId, long[] groupIds, String keywords, String structureId, String structureIdComparator, int start, int end, OrderByComparator obc)
           
static JournalTemplateSoap[] search(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(long companyId, long[] groupIds, String keywords, String structureId, String structureIdComparator)
           
static int searchCount(long companyId, long[] groupIds, String templateId, String structureId, String structureIdComparator, String name, String description, boolean andOperator)
           
static JournalTemplateSoap updateTemplate(long groupId, String templateId, String structureId, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, 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

JournalTemplateServiceSoap

public JournalTemplateServiceSoap()
Method Detail

addTemplate

public static JournalTemplateSoap addTemplate(long groupId,
                                              String templateId,
                                              boolean autoTemplateId,
                                              String structureId,
                                              String[] nameMapLanguageIds,
                                              String[] nameMapValues,
                                              String[] descriptionMapLanguageIds,
                                              String[] descriptionMapValues,
                                              String xsl,
                                              boolean formatXsl,
                                              String langType,
                                              boolean cacheable,
                                              ServiceContext serviceContext)
                                       throws RemoteException
Throws:
RemoteException

copyTemplate

public static JournalTemplateSoap copyTemplate(long groupId,
                                               String oldTemplateId,
                                               String newTemplateId,
                                               boolean autoTemplateId)
                                        throws RemoteException
Throws:
RemoteException

deleteTemplate

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

getStructureTemplates

public static JournalTemplateSoap[] getStructureTemplates(long groupId,
                                                          String structureId)
                                                   throws RemoteException
Throws:
RemoteException

getTemplate

public static JournalTemplateSoap getTemplate(long groupId,
                                              String templateId)
                                       throws RemoteException
Throws:
RemoteException

getTemplate

public static JournalTemplateSoap getTemplate(long groupId,
                                              String templateId,
                                              boolean includeGlobalTemplates)
                                       throws RemoteException
Throws:
RemoteException

search

public static JournalTemplateSoap[] search(long companyId,
                                           long[] groupIds,
                                           String keywords,
                                           String structureId,
                                           String structureIdComparator,
                                           int start,
                                           int end,
                                           OrderByComparator obc)
                                    throws RemoteException
Throws:
RemoteException

search

public static JournalTemplateSoap[] search(long companyId,
                                           long[] groupIds,
                                           String templateId,
                                           String structureId,
                                           String structureIdComparator,
                                           String name,
                                           String description,
                                           boolean andOperator,
                                           int start,
                                           int end,
                                           OrderByComparator obc)
                                    throws RemoteException
Throws:
RemoteException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              String keywords,
                              String structureId,
                              String structureIdComparator)
                       throws RemoteException
Throws:
RemoteException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              String templateId,
                              String structureId,
                              String structureIdComparator,
                              String name,
                              String description,
                              boolean andOperator)
                       throws RemoteException
Throws:
RemoteException

updateTemplate

public static JournalTemplateSoap updateTemplate(long groupId,
                                                 String templateId,
                                                 String structureId,
                                                 String[] nameMapLanguageIds,
                                                 String[] nameMapValues,
                                                 String[] descriptionMapLanguageIds,
                                                 String[] descriptionMapValues,
                                                 String xsl,
                                                 boolean formatXsl,
                                                 String langType,
                                                 boolean cacheable,
                                                 ServiceContext serviceContext)
                                          throws RemoteException
Throws:
RemoteException

Liferay 6.1.2-ce-ga3