Interface KaleoProcessService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseService
- All Known Implementing Classes:
KaleoProcessServiceWrapper
@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
Provides the remote service interface for KaleoProcess. Methods of this
service are expected to have security checks based on the propagated JAAS
credentials because this service can be accessed remotely.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddKaleoProcess(long groupId, long ddmStructureId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, long ddmTemplateId, String workflowDefinitionName, int workflowDefinitionVersion, KaleoTaskFormPairs kaleoTaskFormPairs, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a kaleo process.deleteKaleoProcess(long kaleoProcessId) Deletes the Kaleo process and its resources.getKaleoProcess(long kaleoProcessId) Returns the Kaleo process with the primary key.Returns the OSGi service identifier.search(long groupId, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoProcess> 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.intsearchCount(long groupId, String keywords) Returns the number of Kaleo processes matching the parameters.updateKaleoProcess(long kaleoProcessId, long ddmStructureId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, long ddmTemplateId, String workflowDefinitionName, int workflowDefinitionVersion, KaleoTaskFormPairs kaleoTaskFormPairs, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the Kaleo process.
-
Method Details
-
addKaleoProcess
KaleoProcess addKaleoProcess(long groupId, long ddmStructureId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, long ddmTemplateId, String workflowDefinitionName, int workflowDefinitionVersion, KaleoTaskFormPairs kaleoTaskFormPairs, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a kaleo process.- Parameters:
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 theportal.workflow.kaleo.forms.apimodule'sKaleoTaskFormPairsclass.serviceContext- the service context to be applied. This can set guest permissions and group permissions for the Kaleo process.- Returns:
- the Kaleo process
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-
deleteKaleoProcess
KaleoProcess deleteKaleoProcess(long kaleoProcessId) throws com.liferay.portal.kernel.exception.PortalException Deletes the Kaleo process and its resources.- Parameters:
kaleoProcessId- the primary key of the kaleo process to delete- Returns:
- the deleted Kaleo process
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-
getKaleoProcess
@Transactional(propagation=SUPPORTS, readOnly=true) KaleoProcess getKaleoProcess(long kaleoProcessId) throws com.liferay.portal.kernel.exception.PortalException Returns the Kaleo process with the primary key.- Parameters:
kaleoProcessId- the primary key of the Kaleo process- Returns:
- the Kaleo process
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a Kaleo process with the primary key could not be found
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<KaleoProcess> search(long groupId, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoProcess> 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.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POS, which resides inportal-kernel, will return the full result set.- Parameters:
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 (optionallynull). If the keywords value is notnull, the search uses theORoperator for connecting query criteria; otherwise it uses theANDoperator.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- Returns:
- the range of matching Kaleo processes ordered by the comparator
-
searchCount
Returns the number of Kaleo processes matching the parameters. The keywords parameter is used for matching String values to the Kaleo process's name or description.- Parameters:
groupId- the primary key of the Kaleo process's groupkeywords- the keywords (space separated) to match in the Kaleo process name or description (optionallynull). If the keywords value is notnull, theORoperator is used for connecting query criteria; otherwise it uses theANDoperator.- Returns:
- the number of matching Kaleo processes
-
updateKaleoProcess
KaleoProcess updateKaleoProcess(long kaleoProcessId, long ddmStructureId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, long ddmTemplateId, String workflowDefinitionName, int workflowDefinitionVersion, KaleoTaskFormPairs kaleoTaskFormPairs, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the Kaleo process.- Parameters:
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 theportal.workflow.kaleo.forms.apimodule'sKaleoTaskFormPairsclass.serviceContext- the service context to be applied. This can set guest permissions and group permissions for the Kaleo process.- Returns:
- the Kaleo process
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-