@AccessControlled
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface KaleoProcessService
extends com.liferay.portal.kernel.service.BaseService
KaleoProcessServiceUtil
,
com.liferay.portal.workflow.kaleo.forms.service.base.KaleoProcessServiceBaseImpl
,
com.liferay.portal.workflow.kaleo.forms.service.impl.KaleoProcessServiceImpl
Modifier and Type | Method and Description |
---|---|
KaleoProcess |
addKaleoProcess(long groupId,
long ddmStructureId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
long ddmTemplateId,
java.lang.String workflowDefinitionName,
int workflowDefinitionVersion,
KaleoTaskFormPairs kaleoTaskFormPairs,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a kaleo process.
|
KaleoProcess |
deleteKaleoProcess(long kaleoProcessId)
Deletes the Kaleo process and its resources.
|
KaleoProcess |
getKaleoProcess(long kaleoProcessId)
Returns the Kaleo process with the primary key.
|
java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
java.util.List<KaleoProcess> |
search(long groupId,
java.lang.String keywords,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
Returns an ordered range of all Kaleo processes matching the parameters,
including a keywords parameter for matching String values to the Kaleo
process's name or description.
|
int |
searchCount(long groupId,
java.lang.String keywords)
Returns the number of Kaleo processes matching the parameters.
|
KaleoProcess |
updateKaleoProcess(long kaleoProcessId,
long ddmStructureId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
long ddmTemplateId,
java.lang.String workflowDefinitionName,
int workflowDefinitionVersion,
KaleoTaskFormPairs kaleoTaskFormPairs,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the Kaleo process.
|
KaleoProcess addKaleoProcess(long groupId, long ddmStructureId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, long ddmTemplateId, java.lang.String workflowDefinitionName, int workflowDefinitionVersion, KaleoTaskFormPairs kaleoTaskFormPairs, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the Kaleo process's groupddmStructureId
- the primary key of the Kaleo process's DDM
structurenameMap
- the Kaleo process's locales and localized namesdescriptionMap
- the Kaleo process's locales and localized
descriptionsddmTemplateId
- the primary key of the Kaleo process's DDM templateworkflowDefinitionName
- the Kaleo process's workflow definition
nameworkflowDefinitionVersion
- the Kaleo process's workflow definition
versionkaleoTaskFormPairs
- the Kaleo task form pairs. For more
information, see the portal.workflow.kaleo.forms.api
module's KaleoTaskFormPairs
class.serviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo process.com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurredKaleoProcess deleteKaleoProcess(long kaleoProcessId) throws com.liferay.portal.kernel.exception.PortalException
kaleoProcessId
- the primary key of the kaleo process to deletecom.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) KaleoProcess getKaleoProcess(long kaleoProcessId) throws com.liferay.portal.kernel.exception.PortalException
kaleoProcessId
- the primary key of the Kaleo processcom.liferay.portal.kernel.exception.PortalException
- if a Kaleo process with the primary key could not
be foundKaleoProcess updateKaleoProcess(long kaleoProcessId, long ddmStructureId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, long ddmTemplateId, java.lang.String workflowDefinitionName, int workflowDefinitionVersion, KaleoTaskFormPairs kaleoTaskFormPairs, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
kaleoProcessId
- the primary key of the Kaleo processddmStructureId
- the primary key of the Kaleo process's DDM
structurenameMap
- the Kaleo process's locales and localized namesdescriptionMap
- the Kaleo process's locales and localized
descriptionsddmTemplateId
- the primary key of the Kaleo process's DDM templateworkflowDefinitionName
- the Kaleo process's workflow definition
nameworkflowDefinitionVersion
- the Kaleo process's workflow definition
versionkaleoTaskFormPairs
- the Kaleo task form pairs. For more
information, see the portal.workflow.kaleo.forms.api
module's KaleoTaskFormPairs
class.serviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo process.com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long groupId, java.lang.String keywords)
groupId
- the primary key of the Kaleo process's groupkeywords
- the keywords (space separated) to match in the Kaleo
process name or description (optionally null
). If
the keywords value is not null
, the OR
operator is used for connecting query criteria; otherwise it uses
the AND
operator.java.lang.String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<KaleoProcess> search(long groupId, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
, which resides in
portal-kernel
, will return the full result set.
groupId
- the primary key of the Kaleo process's groupkeywords
- the keywords (space separated) to look for and match in
the Kaleo process name or description (optionally
null
). If the keywords value is not
null
, the search uses the OR
operator
for connecting query criteria; otherwise it uses the
AND
operator.start
- the lower bound of the range of Kaleo processes to returnend
- the upper bound of the range of Kaleo processes to return
(not inclusive)orderByComparator
- the comparator to order the Kaleo processes