Class KaleoProcessLocalServiceUtil
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:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic KaleoProcessaddKaleoProcess(long userId, 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.static KaleoProcessaddKaleoProcess(KaleoProcess kaleoProcess) Adds the kaleo process to the database.static KaleoProcesscreateKaleoProcess(long kaleoProcessId) Creates a new kaleo process with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static KaleoProcessdeleteKaleoProcess(long kaleoProcessId) Deletes the kaleo process with the primary key from the database.static KaleoProcessdeleteKaleoProcess(KaleoProcess kaleoProcess) Deletes the kaleo process from the database.static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> 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> 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> 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 longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(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 KaleoProcessfetchKaleoProcess(long kaleoProcessId) static KaleoProcessfetchKaleoProcessByUuidAndGroupId(String uuid, long groupId) Returns the kaleo process matching the UUID and group.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic KaleoProcessgetDDLRecordSetKaleoProcess(long ddlRecordSetId) Returns the Kaleo process matching the DDL record set ID.static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic KaleoProcessgetKaleoProcess(long kaleoProcessId) Returns the kaleo process with the primary key.static KaleoProcessgetKaleoProcessByUuidAndGroupId(String uuid, long groupId) Returns the kaleo process matching the UUID and group.static List<KaleoProcess> getKaleoProcesses(int start, int end) Returns a range of all the kaleo processes.static List<KaleoProcess> getKaleoProcesses(long groupId) Returns all the Kaleo processes belonging to the group.static List<KaleoProcess> getKaleoProcesses(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoProcess> orderByComparator) Returns an ordered range of all Kaleo processes belonging to the group.static List<KaleoProcess> getKaleoProcessesByUuidAndCompanyId(String uuid, long companyId) Returns all the kaleo processes matching the UUID and company.static List<KaleoProcess> getKaleoProcessesByUuidAndCompanyId(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 intReturns the number of kaleo processes.static intgetKaleoProcessesCount(long groupId) Returns the number of Kaleo processes belonging to the group.static StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static KaleoProcessLocalServicestatic KaleoProcessupdateKaleoProcess(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.static KaleoProcessupdateKaleoProcess(KaleoProcess kaleoProcess) Updates the kaleo process in the database or adds it if it does not yet exist.
-
Constructor Details
-
KaleoProcessLocalServiceUtil
public KaleoProcessLocalServiceUtil()
-
-
Method Details
-
addKaleoProcess
Adds the kaleo process to the database. Also notifies the appropriate model listeners.Important: Inspect KaleoProcessLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
kaleoProcess- the kaleo process- Returns:
- the kaleo process that was added
-
addKaleoProcess
public static KaleoProcess addKaleoProcess(long userId, 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:
userId- the primary key of the Kaleo process's creator/ownergroupId- 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 used to create a Kaleo process link. SeeKaleoTaskFormPairsin theportal.workflow.kaleo.forms.apimodule.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
-
createKaleoProcess
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
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
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.Important: Inspect KaleoProcessLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
kaleoProcess- the kaleo process- Returns:
- the kaleo process that was removed
- Throws:
com.liferay.portal.kernel.exception.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.Important: Inspect KaleoProcessLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
kaleoProcessId- the primary key of the kaleo process- Returns:
- the kaleo process that was removed
- Throws:
com.liferay.portal.kernel.exception.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:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.DynamicQuery 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> 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.workflow.kaleo.forms.model.impl.KaleoProcessModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.workflow.kaleo.forms.model.impl.KaleoProcessModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchKaleoProcess
-
fetchKaleoProcessByUuidAndGroupId
Returns the kaleo process matching the UUID and group.- Parameters:
uuid- the kaleo process's UUIDgroupId- the primary key of the group- Returns:
- the matching kaleo process, or
nullif 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:
com.liferay.portal.kernel.exception.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:
com.liferay.portal.kernel.exception.PortalException- if a kaleo process with the primary key could not be found
-
getKaleoProcessByUuidAndGroupId
public static KaleoProcess getKaleoProcessByUuidAndGroupId(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 UUIDgroupId- the primary key of the group- Returns:
- the matching kaleo process
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a matching kaleo process could not be found
-
getKaleoProcesses
Returns a range of all the kaleo processes.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 bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.workflow.kaleo.forms.model.impl.KaleoProcessModelImpl.- Parameters:
start- the lower bound of the range of kaleo processesend- the upper bound of the range of kaleo processes (not inclusive)- Returns:
- the range of kaleo processes
-
getKaleoProcesses
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 List<KaleoProcess> getKaleoProcesses(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoProcess> orderByComparator) Returns an ordered range of all Kaleo processes belonging to the group.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 processes' groupstart- 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
-
getKaleoProcessesByUuidAndCompanyId
Returns all the kaleo processes matching the UUID and company.- Parameters:
uuid- the UUID of the kaleo processescompanyId- the primary key of the company- Returns:
- the matching kaleo processes, or an empty list if no matches were found
-
getKaleoProcessesByUuidAndCompanyId
public static List<KaleoProcess> getKaleoProcessesByUuidAndCompanyId(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 processescompanyId- the primary key of the companystart- the lower bound of the range of kaleo processesend- the upper bound of the range of kaleo processes (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKaleoProcess
Updates the kaleo process in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect KaleoProcessLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
kaleoProcess- the kaleo process- Returns:
- the kaleo process that was updated
-
updateKaleoProcess
public static 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
-
getService
-