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:
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 start,
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 start,
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 start,
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 start,
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 start,
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 start,
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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