com.liferay.portlet.workflow.service.http
Class WorkflowComponentServiceJSON
java.lang.Object
com.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
com.liferay.portal.kernel.json.JSONArray
. If the method in the
service utility returns a com.liferay.portlet.workflow.model.WorkflowComponent
,
that is translated to a
com.liferay.portal.kernel.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
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 |
WorkflowComponentServiceJSON
public WorkflowComponentServiceJSON()
getCurrentTasks
public static java.util.List getCurrentTasks(long instanceId,
long tokenId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getCurrentTasksXml
public static java.lang.String getCurrentTasksXml(long instanceId,
long tokenId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
deploy
public static java.lang.String deploy(java.lang.String xml)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getDefinition
public static java.lang.Object getDefinition(long definitionId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getDefinitions
public static java.util.List getDefinitions(long definitionId,
java.lang.String name,
int start,
int end)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getDefinitionsXml
public static java.lang.String getDefinitionsXml(long definitionId,
java.lang.String name,
int start,
int end)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getDefinitionsCount
public static int getDefinitionsCount(long definitionId,
java.lang.String name)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getDefinitionsCountXml
public static java.lang.String getDefinitionsCountXml(long definitionId,
java.lang.String name)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getDefinitionXml
public static java.lang.String getDefinitionXml(long definitionId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
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,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
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,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
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,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
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,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getTask
public static com.liferay.portlet.workflow.model.WorkflowTask getTask(long taskId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getTaskXml
public static java.lang.String getTaskXml(long taskId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getTaskFormElements
public static java.util.List getTaskFormElements(long taskId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getTaskFormElementsXml
public static java.lang.String getTaskFormElementsXml(long taskId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getTaskTransitions
public static java.util.List getTaskTransitions(long taskId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getTaskTransitionsXml
public static java.lang.String getTaskTransitionsXml(long taskId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
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,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
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,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
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,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
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,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
signalInstance
public static void signalInstance(long instanceId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
signalToken
public static void signalToken(long instanceId,
long tokenId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
startWorkflow
public static java.lang.String startWorkflow(long definitionId)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException