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 Details

    • addKaleoProcess

      KaleoProcess addKaleoProcess(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) throws com.liferay.portal.kernel.exception.PortalException
      Adds a kaleo process.
      Parameters:
      groupId - the primary key of the Kaleo process's group
      ddmStructureId - the primary key of the Kaleo process's DDM structure
      nameMap - the Kaleo process's locales and localized names
      descriptionMap - the Kaleo process's locales and localized descriptions
      ddmTemplateId - the primary key of the Kaleo process's DDM template
      workflowDefinitionName - the Kaleo process's workflow definition name
      workflowDefinitionVersion - the Kaleo process's workflow definition version
      kaleoTaskFormPairs - 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.
      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 - 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.

      Parameters:
      groupId - the primary key of the Kaleo process's group
      keywords - 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 return
      end - 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

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long groupId, String keywords)
      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 group
      keywords - 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.
      Returns:
      the number of matching Kaleo processes
    • updateKaleoProcess

      KaleoProcess 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) throws com.liferay.portal.kernel.exception.PortalException
      Updates the Kaleo process.
      Parameters:
      kaleoProcessId - the primary key of the Kaleo process
      ddmStructureId - the primary key of the Kaleo process's DDM structure
      nameMap - the Kaleo process's locales and localized names
      descriptionMap - the Kaleo process's locales and localized descriptions
      ddmTemplateId - the primary key of the Kaleo process's DDM template
      workflowDefinitionName - the Kaleo process's workflow definition name
      workflowDefinitionVersion - the Kaleo process's workflow definition version
      kaleoTaskFormPairs - 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.
      Returns:
      the Kaleo process
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred