com.liferay.portlet.workflow.service
Interface WorkflowComponentService
- public interface WorkflowComponentService
View Source
ServiceBuilder generated this class. Modifications in this class will be
overwritten the next time is generated.
This interface defines the service. The default implementation is
com.liferay.portlet.workflow.service.impl.WorkflowComponentServiceImpl
.
Modify methods in that class and rerun ServiceBuilder to populate this class
and all other generated classes.
This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
- Author:
- Brian Wing Shun Chan
- See Also:
WorkflowComponentServiceFactory
,
WorkflowComponentServiceUtil
Method Summary |
java.lang.String |
deploy(java.lang.String xml)
|
java.util.List |
getCurrentTasks(long instanceId,
long tokenId)
|
java.lang.String |
getCurrentTasksXml(long instanceId,
long tokenId)
|
java.lang.Object |
getDefinition(long definitionId)
|
java.util.List |
getDefinitions(long definitionId,
java.lang.String name,
int begin,
int end)
|
int |
getDefinitionsCount(long definitionId,
java.lang.String name)
|
java.lang.String |
getDefinitionsCountXml(long definitionId,
java.lang.String name)
|
java.lang.String |
getDefinitionsXml(long definitionId,
java.lang.String name,
int begin,
int end)
|
java.lang.String |
getDefinitionXml(long definitionId)
|
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 begin,
int end)
|
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)
|
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)
|
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 begin,
int end)
|
WorkflowTask |
getTask(long taskId)
|
java.util.List |
getTaskFormElements(long taskId)
|
java.lang.String |
getTaskFormElementsXml(long taskId)
|
java.util.List |
getTaskTransitions(long taskId)
|
java.lang.String |
getTaskTransitionsXml(long taskId)
|
java.lang.String |
getTaskXml(long taskId)
|
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)
|
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)
|
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)
|
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)
|
void |
signalInstance(long instanceId)
|
void |
signalToken(long instanceId,
long tokenId)
|
java.lang.String |
startWorkflow(long definitionId)
|
java.util.Map |
updateTask(long taskId,
java.lang.String transition,
java.util.Map parameterMap)
|
java.lang.String |
updateTaskXml(long taskId,
java.lang.String transition,
java.util.Map parameterMap)
|
getCurrentTasks
public 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 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 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 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 java.util.List getDefinitions(long definitionId,
java.lang.String name,
int begin,
int end)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getDefinitionsXml
public java.lang.String getDefinitionsXml(long definitionId,
java.lang.String name,
int begin,
int end)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getDefinitionsCount
public 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 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 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 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 begin,
int end)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getInstancesCount
public 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 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 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 begin,
int end)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getTask
public 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 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 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 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 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 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 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 java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
getUserTasksCount
public 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 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 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 java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
signalInstance
public 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 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 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
updateTask
public java.util.Map updateTask(long taskId,
java.lang.String transition,
java.util.Map parameterMap)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException
updateTaskXml
public java.lang.String updateTaskXml(long taskId,
java.lang.String transition,
java.util.Map parameterMap)
throws java.rmi.RemoteException,
com.liferay.portal.kernel.jbi.WorkflowComponentException
- Throws:
java.rmi.RemoteException
com.liferay.portal.kernel.jbi.WorkflowComponentException