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

java.lang.Object
  extended bycom.liferay.portlet.workflow.service.http.WorkflowComponentServiceJSON

public class WorkflowComponentServiceJSON
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 JSON 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 JSON 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 a org.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.workflow.model.WorkflowComponent, that is translated to a org.json.JSONObject. Methods that JSON cannot safely use are skipped. The logic for the translation is encapsulated in com.liferay.portlet.workflow.service.http.WorkflowComponentJSONSerializer.

This allows you to call the the backend services directly from JavaScript. See portal-web/docroot/html/portlet/tags_admin/unpacked.js for a reference of how that portlet uses the generated JavaScript in portal-web/docroot/html/js/service.js to call the backend services directly from JavaScript.

The JSON utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
WorkflowComponentServiceUtil, com.liferay.portlet.workflow.service.http.WorkflowComponentJSONSerializer

Constructor Summary
WorkflowComponentServiceJSON()
           
 
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 begin, 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 begin, 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 andOperator, int begin, 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 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 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 andOperator, int begin, int end)
           
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.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 begin, 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 begin, 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

WorkflowComponentServiceJSON

public WorkflowComponentServiceJSON()
Method Detail

getCurrentTasks

public static java.util.List getCurrentTasks(long instanceId,
                                             long tokenId)
                                      throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                             java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getCurrentTasksXml

public static java.lang.String getCurrentTasksXml(long instanceId,
                                                  long tokenId)
                                           throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                                  java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

deploy

public static java.lang.String deploy(java.lang.String xml)
                               throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                      java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getDefinition

public static java.lang.Object getDefinition(long definitionId)
                                      throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                             java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getDefinitions

public static java.util.List getDefinitions(long definitionId,
                                            java.lang.String name,
                                            int begin,
                                            int end)
                                     throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                            java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getDefinitionsXml

public static java.lang.String getDefinitionsXml(long definitionId,
                                                 java.lang.String name,
                                                 int begin,
                                                 int end)
                                          throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                                 java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getDefinitionsCount

public static int getDefinitionsCount(long definitionId,
                                      java.lang.String name)
                               throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                      java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getDefinitionsCountXml

public static java.lang.String getDefinitionsCountXml(long definitionId,
                                                      java.lang.String name)
                                               throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                                      java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getDefinitionXml

public static java.lang.String getDefinitionXml(long definitionId)
                                         throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                                java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
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 andOperator,
                                          int begin,
                                          int end)
                                   throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                          java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
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 andOperator)
                             throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                    java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
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 andOperator)
                                             throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                                    java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
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 andOperator,
                                               int begin,
                                               int end)
                                        throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                               java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getTaskFormElements

public static java.util.List getTaskFormElements(long taskId)
                                          throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                                 java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getTaskFormElementsXml

public static java.lang.String getTaskFormElementsXml(long taskId)
                                               throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                                      java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getTaskTransitions

public static java.util.List getTaskTransitions(long taskId)
                                         throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                                java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

getTaskTransitionsXml

public static java.lang.String getTaskTransitionsXml(long taskId)
                                              throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                                     java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
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 begin,
                                          int end)
                                   throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                          java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
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 com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                    java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
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 com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                                    java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
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 begin,
                                               int end)
                                        throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                               java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

signalInstance

public static void signalInstance(long instanceId)
                           throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                  java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

signalToken

public static void signalToken(long instanceId,
                               long tokenId)
                        throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                               java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException

startWorkflow

public static java.lang.String startWorkflow(long definitionId)
                                      throws com.liferay.portal.kernel.jbi.WorkflowComponentException,
                                             java.rmi.RemoteException
Throws:
com.liferay.portal.kernel.jbi.WorkflowComponentException
java.rmi.RemoteException