com.liferay.portlet.workflow.service.http
Class WorkflowComponentServiceSoap

java.lang.Object
  extended by com.liferay.portlet.workflow.service.http.WorkflowComponentServiceSoap

public class WorkflowComponentServiceSoap
extends java.lang.Object

View Source

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

This class provides a SOAP utility for the com.liferay.portlet.workflow.service.WorkflowComponentServiceUtil 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 java.util.List, that is translated to an array of com.liferay.portlet.workflow.model.WorkflowComponentSoap. If the method in the service utility returns a com.liferay.portlet.workflow.model.WorkflowComponent, that is translated to a com.liferay.portlet.workflow.model.WorkflowComponentSoap. 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/tunnel-web/secure/axis. Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
WorkflowComponentServiceUtil, WorkflowComponentServiceHttp, com.liferay.portlet.workflow.service.model.WorkflowComponentSoap

Constructor Summary
WorkflowComponentServiceSoap()
           
 
Method Summary
static java.lang.String deploy(java.lang.String xml)
           
static java.util.List getCurrentTasks(long instanceId, long tokenId)
           
static java.lang.String getCurrentTasksXml(long instanceId, long tokenId)
           
static java.lang.Object getDefinition(long definitionId)
           
static java.util.List getDefinitions(long definitionId, java.lang.String name, int start, int end)
           
static int getDefinitionsCount(long definitionId, java.lang.String name)
           
static java.lang.String getDefinitionsCountXml(long definitionId, java.lang.String name)
           
static java.lang.String getDefinitionsXml(long definitionId, java.lang.String name, int start, int end)
           
static java.lang.String getDefinitionXml(long definitionId)
           
static java.util.List getInstances(long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator, int start, int end)
           
static int getInstancesCount(long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator)
           
static java.lang.String getInstancesCountXml(long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator)
           
static java.lang.String getInstancesXml(long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator, int start, int end)
           
static com.liferay.portlet.workflow.model.WorkflowTask getTask(long taskId)
           
static java.util.List getTaskFormElements(long taskId)
           
static java.lang.String getTaskFormElementsXml(long taskId)
           
static java.util.List getTaskTransitions(long taskId)
           
static java.lang.String getTaskTransitionsXml(long taskId)
           
static java.lang.String getTaskXml(long taskId)
           
static java.util.List getUserTasks(long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator, int start, int end)
           
static int getUserTasksCount(long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator)
           
static java.lang.String getUserTasksCountXml(long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator)
           
static java.lang.String getUserTasksXml(long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator, int start, int end)
           
static void signalInstance(long instanceId)
           
static void signalToken(long instanceId, long tokenId)
           
static java.lang.String startWorkflow(long definitionId)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkflowComponentServiceSoap

public WorkflowComponentServiceSoap()
Method Detail

getCurrentTasks

public static java.util.List getCurrentTasks(long instanceId,
                                             long tokenId)
                                      throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getCurrentTasksXml

public static java.lang.String getCurrentTasksXml(long instanceId,
                                                  long tokenId)
                                           throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

deploy

public static java.lang.String deploy(java.lang.String xml)
                               throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getDefinition

public static java.lang.Object getDefinition(long definitionId)
                                      throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getDefinitions

public static java.util.List getDefinitions(long definitionId,
                                            java.lang.String name,
                                            int start,
                                            int end)
                                     throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getDefinitionsXml

public static java.lang.String getDefinitionsXml(long definitionId,
                                                 java.lang.String name,
                                                 int start,
                                                 int end)
                                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getDefinitionsCount

public static int getDefinitionsCount(long definitionId,
                                      java.lang.String name)
                               throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getDefinitionsCountXml

public static java.lang.String getDefinitionsCountXml(long definitionId,
                                                      java.lang.String name)
                                               throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getDefinitionXml

public static java.lang.String getDefinitionXml(long definitionId)
                                         throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getInstances

public static java.util.List getInstances(long definitionId,
                                          long instanceId,
                                          java.lang.String definitionName,
                                          java.lang.String definitionVersion,
                                          java.lang.String startDateGT,
                                          java.lang.String startDateLT,
                                          java.lang.String endDateGT,
                                          java.lang.String endDateLT,
                                          boolean hideEndedTasks,
                                          boolean retrieveUserInstances,
                                          boolean andOperator,
                                          int start,
                                          int end)
                                   throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getInstancesCount

public static int getInstancesCount(long definitionId,
                                    long instanceId,
                                    java.lang.String definitionName,
                                    java.lang.String definitionVersion,
                                    java.lang.String startDateGT,
                                    java.lang.String startDateLT,
                                    java.lang.String endDateGT,
                                    java.lang.String endDateLT,
                                    boolean hideEndedTasks,
                                    boolean retrieveUserInstances,
                                    boolean andOperator)
                             throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getInstancesCountXml

public static java.lang.String getInstancesCountXml(long definitionId,
                                                    long instanceId,
                                                    java.lang.String definitionName,
                                                    java.lang.String definitionVersion,
                                                    java.lang.String startDateGT,
                                                    java.lang.String startDateLT,
                                                    java.lang.String endDateGT,
                                                    java.lang.String endDateLT,
                                                    boolean hideEndedTasks,
                                                    boolean retrieveUserInstances,
                                                    boolean andOperator)
                                             throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getInstancesXml

public static java.lang.String getInstancesXml(long definitionId,
                                               long instanceId,
                                               java.lang.String definitionName,
                                               java.lang.String definitionVersion,
                                               java.lang.String startDateGT,
                                               java.lang.String startDateLT,
                                               java.lang.String endDateGT,
                                               java.lang.String endDateLT,
                                               boolean hideEndedTasks,
                                               boolean retrieveUserInstances,
                                               boolean andOperator,
                                               int start,
                                               int end)
                                        throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getTask

public static com.liferay.portlet.workflow.model.WorkflowTask getTask(long taskId)
                                                               throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getTaskXml

public static java.lang.String getTaskXml(long taskId)
                                   throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getTaskFormElements

public static java.util.List getTaskFormElements(long taskId)
                                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getTaskFormElementsXml

public static java.lang.String getTaskFormElementsXml(long taskId)
                                               throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getTaskTransitions

public static java.util.List getTaskTransitions(long taskId)
                                         throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getTaskTransitionsXml

public static java.lang.String getTaskTransitionsXml(long taskId)
                                              throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getUserTasks

public static java.util.List getUserTasks(long instanceId,
                                          java.lang.String taskName,
                                          java.lang.String definitionName,
                                          java.lang.String assignedTo,
                                          java.lang.String createDateGT,
                                          java.lang.String createDateLT,
                                          java.lang.String startDateGT,
                                          java.lang.String startDateLT,
                                          java.lang.String endDateGT,
                                          java.lang.String endDateLT,
                                          boolean hideEndedTasks,
                                          boolean andOperator,
                                          int start,
                                          int end)
                                   throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getUserTasksCount

public static int getUserTasksCount(long instanceId,
                                    java.lang.String taskName,
                                    java.lang.String definitionName,
                                    java.lang.String assignedTo,
                                    java.lang.String createDateGT,
                                    java.lang.String createDateLT,
                                    java.lang.String startDateGT,
                                    java.lang.String startDateLT,
                                    java.lang.String endDateGT,
                                    java.lang.String endDateLT,
                                    boolean hideEndedTasks,
                                    boolean andOperator)
                             throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getUserTasksCountXml

public static java.lang.String getUserTasksCountXml(long instanceId,
                                                    java.lang.String taskName,
                                                    java.lang.String definitionName,
                                                    java.lang.String assignedTo,
                                                    java.lang.String createDateGT,
                                                    java.lang.String createDateLT,
                                                    java.lang.String startDateGT,
                                                    java.lang.String startDateLT,
                                                    java.lang.String endDateGT,
                                                    java.lang.String endDateLT,
                                                    boolean hideEndedTasks,
                                                    boolean andOperator)
                                             throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getUserTasksXml

public static java.lang.String getUserTasksXml(long instanceId,
                                               java.lang.String taskName,
                                               java.lang.String definitionName,
                                               java.lang.String assignedTo,
                                               java.lang.String createDateGT,
                                               java.lang.String createDateLT,
                                               java.lang.String startDateGT,
                                               java.lang.String startDateLT,
                                               java.lang.String endDateGT,
                                               java.lang.String endDateLT,
                                               boolean hideEndedTasks,
                                               boolean andOperator,
                                               int start,
                                               int end)
                                        throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

signalInstance

public static void signalInstance(long instanceId)
                           throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

signalToken

public static void signalToken(long instanceId,
                               long tokenId)
                        throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

startWorkflow

public static java.lang.String startWorkflow(long definitionId)
                                      throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException