com.liferay.portal.workflow.kaleo.forms.service

Class KaleoProcessLocalServiceUtil

java.lang.Object

com.liferay.portal.workflow.kaleo.forms.service.KaleoProcessLocalServiceUtil

@ProviderType
public class KaleoProcessLocalServiceUtil
extends java.lang.Object

Provides the local service utility for KaleoProcess. This utility wraps com.liferay.portal.workflow.kaleo.forms.service.impl.KaleoProcessLocalServiceImpl and is an access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

KaleoProcessLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
KaleoProcessLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static KaleoProcess	addKaleoProcess(KaleoProcess kaleoProcess) Adds the kaleo process to the database.
static KaleoProcess	addKaleoProcess(long userId, 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.
static KaleoProcess	createKaleoProcess(long kaleoProcessId) Creates a new kaleo process with the primary key.
static KaleoProcess	deleteKaleoProcess(KaleoProcess kaleoProcess) Deletes the kaleo process from the database.
static KaleoProcess	deleteKaleoProcess(long kaleoProcessId) Deletes the kaleo process with the primary key from the database.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
static KaleoProcess	fetchKaleoProcess(long kaleoProcessId)
static KaleoProcess	fetchKaleoProcessByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the kaleo process matching the UUID and group.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static KaleoProcess	getDDLRecordSetKaleoProcess(long ddlRecordSetId) Returns the Kaleo process matching the DDL record set ID.
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static KaleoProcess	getKaleoProcess(long kaleoProcessId) Returns the kaleo process with the primary key.
static KaleoProcess	getKaleoProcessByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the kaleo process matching the UUID and group.
static java.util.List<KaleoProcess>	getKaleoProcesses(int start, int end) Returns a range of all the kaleo processes.
static java.util.List<KaleoProcess>	getKaleoProcesses(long groupId) Returns all the Kaleo processes belonging to the group.
static java.util.List<KaleoProcess>	getKaleoProcesses(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator) Returns an ordered range of all Kaleo processes belonging to the group.
static java.util.List<KaleoProcess>	getKaleoProcessesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the kaleo processes matching the UUID and company.
static java.util.List<KaleoProcess>	getKaleoProcessesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoProcess> orderByComparator) Returns a range of kaleo processes matching the UUID and company.
static int	getKaleoProcessesCount() Returns the number of kaleo processes.
static int	getKaleoProcessesCount(long groupId) Returns the number of Kaleo processes belonging to the group.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static KaleoProcessLocalService	getService()
static KaleoProcess	updateKaleoProcess(KaleoProcess kaleoProcess) Updates the kaleo process in the database or adds it if it does not yet exist.
static 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KaleoProcessLocalServiceUtil

public KaleoProcessLocalServiceUtil()

Method Detail

addKaleoProcess

public static KaleoProcess addKaleoProcess(KaleoProcess kaleoProcess)

Adds the kaleo process to the database. Also notifies the appropriate model listeners.

Parameters:

kaleoProcess - the kaleo process

Returns:

the kaleo process that was added

addKaleoProcess

public static KaleoProcess addKaleoProcess(long userId,
                                           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

Adds a Kaleo process.

Parameters:

userId - the primary key of the Kaleo process's creator/owner

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 used to create a Kaleo process link. See KaleoTaskFormPairs in the portal.workflow.kaleo.forms.api module.

serviceContext - the service context to be applied. This can set guest permissions and group permissions for the Kaleo process.

Returns:

the Kaleo process

Throws:

PortalException - if a portal exception occurred

createKaleoProcess

public static KaleoProcess createKaleoProcess(long kaleoProcessId)

Creates a new kaleo process with the primary key. Does not add the kaleo process to the database.

Parameters:

kaleoProcessId - the primary key for the new kaleo process

Returns:

the new kaleo process

deleteKaleoProcess

public static KaleoProcess deleteKaleoProcess(KaleoProcess kaleoProcess)
                                       throws com.liferay.portal.kernel.exception.PortalException

Deletes the kaleo process from the database. Also notifies the appropriate model listeners.

Parameters:

kaleoProcess - the kaleo process

Returns:

the kaleo process that was removed

Throws:

PortalException

deleteKaleoProcess

public static KaleoProcess deleteKaleoProcess(long kaleoProcessId)
                                       throws com.liferay.portal.kernel.exception.PortalException

Deletes the kaleo process with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

kaleoProcessId - the primary key of the kaleo process

Returns:

the kaleo process that was removed

Throws:

PortalException - if a kaleo process with the primary key could not be found

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

Performs a dynamic query on the database and returns a range of the matching rows.

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.workflow.kaleo.forms.model.impl.KaleoProcessModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.workflow.kaleo.forms.model.impl.KaleoProcessModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchKaleoProcess

public static KaleoProcess fetchKaleoProcess(long kaleoProcessId)

fetchKaleoProcessByUuidAndGroupId

public static KaleoProcess fetchKaleoProcessByUuidAndGroupId(java.lang.String uuid,
                                                             long groupId)

Returns the kaleo process matching the UUID and group.

Parameters:

uuid - the kaleo process's UUID

groupId - the primary key of the group

Returns:

the matching kaleo process, or null if a matching kaleo process could not be found

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getDDLRecordSetKaleoProcess

public static KaleoProcess getDDLRecordSetKaleoProcess(long ddlRecordSetId)
                                                throws com.liferay.portal.kernel.exception.PortalException

Returns the Kaleo process matching the DDL record set ID.

Parameters:

ddlRecordSetId - the primary key of the DDL record set associated with the Kaleo process

Returns:

the Kaleo process

Throws:

PortalException - if a matching Kaleo process could not be found

getExportActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getKaleoProcess

public static 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:

PortalException - if a kaleo process with the primary key could not be found

getKaleoProcessByUuidAndGroupId

public static KaleoProcess getKaleoProcessByUuidAndGroupId(java.lang.String uuid,
                                                           long groupId)
                                                    throws com.liferay.portal.kernel.exception.PortalException

Returns the kaleo process matching the UUID and group.

Parameters:

uuid - the kaleo process's UUID

groupId - the primary key of the group

Returns:

the matching kaleo process

Throws:

PortalException - if a matching kaleo process could not be found

getKaleoProcesses

public static java.util.List<KaleoProcess> getKaleoProcesses(int start,
                                                             int end)

Returns a range of all the kaleo processes.

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.workflow.kaleo.forms.model.impl.KaleoProcessModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of kaleo processes

end - the upper bound of the range of kaleo processes (not inclusive)

Returns:

the range of kaleo processes

getKaleoProcesses

public static java.util.List<KaleoProcess> getKaleoProcesses(long groupId)

Returns all the Kaleo processes belonging to the group.

Parameters:

groupId - the primary key of the Kaleo processes's group

Returns:

the Kaleo processes

getKaleoProcesses

public static java.util.List<KaleoProcess> getKaleoProcesses(long groupId,
                                                             int start,
                                                             int end,
                                                             com.liferay.portal.kernel.util.OrderByComparator orderByComparator)

Returns an ordered range of all Kaleo processes belonging to the group.

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 processes' group

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

getKaleoProcessesByUuidAndCompanyId

public static java.util.List<KaleoProcess> getKaleoProcessesByUuidAndCompanyId(java.lang.String uuid,
                                                                               long companyId)

Returns all the kaleo processes matching the UUID and company.

Parameters:

uuid - the UUID of the kaleo processes

companyId - the primary key of the company

Returns:

the matching kaleo processes, or an empty list if no matches were found

getKaleoProcessesByUuidAndCompanyId

public static java.util.List<KaleoProcess> getKaleoProcessesByUuidAndCompanyId(java.lang.String uuid,
                                                                               long companyId,
                                                                               int start,
                                                                               int end,
                                                                               com.liferay.portal.kernel.util.OrderByComparator<KaleoProcess> orderByComparator)

Returns a range of kaleo processes matching the UUID and company.

Parameters:

uuid - the UUID of the kaleo processes

companyId - the primary key of the company

start - the lower bound of the range of kaleo processes

end - the upper bound of the range of kaleo processes (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching kaleo processes, or an empty list if no matches were found

getKaleoProcessesCount

public static int getKaleoProcessesCount()

Returns the number of kaleo processes.

Returns:

the number of kaleo processes

getKaleoProcessesCount

public static int getKaleoProcessesCount(long groupId)

Returns the number of Kaleo processes belonging to the group.

Parameters:

groupId - the primary key of the Kaleo processes' group

Returns:

the number of Kaleo processes

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateKaleoProcess

public static KaleoProcess updateKaleoProcess(KaleoProcess kaleoProcess)

Updates the kaleo process in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

kaleoProcess - the kaleo process

Returns:

the kaleo process that was updated

updateKaleoProcess

public static 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)
                                       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:

PortalException - if a portal exception occurred

getService

public static KaleoProcessLocalService getService()