com.liferay.portal.workflow.kaleo.service

Class KaleoInstanceLocalServiceUtil

java.lang.Object

com.liferay.portal.workflow.kaleo.service.KaleoInstanceLocalServiceUtil

@ProviderType
public class KaleoInstanceLocalServiceUtil
extends java.lang.Object

Provides the local service utility for KaleoInstance. This utility wraps com.liferay.portal.workflow.kaleo.service.impl.KaleoInstanceLocalServiceImpl and is the primary 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:

KaleoInstanceLocalService, com.liferay.portal.workflow.kaleo.service.base.KaleoInstanceLocalServiceBaseImpl, com.liferay.portal.workflow.kaleo.service.impl.KaleoInstanceLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
KaleoInstanceLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static KaleoInstance	addKaleoInstance(KaleoInstance kaleoInstance) Adds the kaleo instance to the database.
static KaleoInstance	addKaleoInstance(long kaleoDefinitionId, java.lang.String kaleoDefinitionName, int kaleoDefinitionVersion, java.util.Map<java.lang.String,java.io.Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static KaleoInstance	completeKaleoInstance(long kaleoInstanceId)
static KaleoInstance	createKaleoInstance(long kaleoInstanceId) Creates a new kaleo instance with the primary key.
static void	deleteCompanyKaleoInstances(long companyId)
static void	deleteKaleoDefinitionKaleoInstances(long kaleoDefinitionId)
static KaleoInstance	deleteKaleoInstance(KaleoInstance kaleoInstance) Deletes the kaleo instance from the database.
static KaleoInstance	deleteKaleoInstance(long kaleoInstanceId) Deletes the kaleo instance 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 KaleoInstance	fetchKaleoInstance(long kaleoInstanceId)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static KaleoInstance	getKaleoInstance(long kaleoInstanceId) Returns the kaleo instance with the primary key.
static java.util.List<KaleoInstance>	getKaleoInstances(int start, int end) Returns a range of all the kaleo instances.
static java.util.List<KaleoInstance>	getKaleoInstances(java.lang.Long userId, java.lang.String[] assetClassNames, java.lang.Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static java.util.List<KaleoInstance>	getKaleoInstances(java.lang.Long userId, java.lang.String assetClassName, java.lang.Long assetClassPK, java.lang.Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static java.util.List<KaleoInstance>	getKaleoInstances(java.lang.String kaleoDefinitionName, int kaleoDefinitionVersion, boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static int	getKaleoInstancesCount() Returns the number of kaleo instances.
static int	getKaleoInstancesCount(long kaleoDefinitionId, boolean completed)
static int	getKaleoInstancesCount(java.lang.Long userId, java.lang.String[] assetClassNames, java.lang.Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static int	getKaleoInstancesCount(java.lang.Long userId, java.lang.String assetClassName, java.lang.Long assetClassPK, java.lang.Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static int	getKaleoInstancesCount(java.lang.String kaleoDefinitionName, int kaleoDefinitionVersion, boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static KaleoInstanceLocalService	getService()
static java.util.List<KaleoInstance>	search(java.lang.Long userId, java.lang.String assetType, java.lang.String nodeName, java.lang.String kaleoDefinitionName, java.lang.Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static int	searchCount(java.lang.Long userId, java.lang.String assetType, java.lang.String nodeName, java.lang.String kaleoDefinitionName, java.lang.Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static KaleoInstance	updateKaleoInstance(KaleoInstance kaleoInstance) Updates the kaleo instance in the database or adds it if it does not yet exist.
static KaleoInstance	updateKaleoInstance(long kaleoInstanceId, java.util.Map<java.lang.String,java.io.Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

KaleoInstanceLocalServiceUtil

public KaleoInstanceLocalServiceUtil()

Method Detail

addKaleoInstance

public static KaleoInstance addKaleoInstance(KaleoInstance kaleoInstance)

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

Parameters:

kaleoInstance - the kaleo instance

Returns:

the kaleo instance that was added

addKaleoInstance

public static KaleoInstance addKaleoInstance(long kaleoDefinitionId,
                                             java.lang.String kaleoDefinitionName,
                                             int kaleoDefinitionVersion,
                                             java.util.Map<java.lang.String,java.io.Serializable> workflowContext,
                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

completeKaleoInstance

public static KaleoInstance completeKaleoInstance(long kaleoInstanceId)
                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createKaleoInstance

public static KaleoInstance createKaleoInstance(long kaleoInstanceId)

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

Parameters:

kaleoInstanceId - the primary key for the new kaleo instance

Returns:

the new kaleo instance

deleteCompanyKaleoInstances

public static void deleteCompanyKaleoInstances(long companyId)

deleteKaleoDefinitionKaleoInstances

public static void deleteKaleoDefinitionKaleoInstances(long kaleoDefinitionId)

deleteKaleoInstance

public static KaleoInstance deleteKaleoInstance(KaleoInstance kaleoInstance)

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

Parameters:

kaleoInstance - the kaleo instance

Returns:

the kaleo instance that was removed

deleteKaleoInstance

public static KaleoInstance deleteKaleoInstance(long kaleoInstanceId)
                                         throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

kaleoInstanceId - the primary key of the kaleo instance

Returns:

the kaleo instance that was removed

Throws:

PortalException - if a kaleo instance 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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.workflow.kaleo.model.impl.KaleoInstanceModelImpl. 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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.workflow.kaleo.model.impl.KaleoInstanceModelImpl. 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

fetchKaleoInstance

public static KaleoInstance fetchKaleoInstance(long kaleoInstanceId)

getActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

getKaleoInstance

public static KaleoInstance getKaleoInstance(long kaleoInstanceId)
                                      throws com.liferay.portal.kernel.exception.PortalException

Returns the kaleo instance with the primary key.

Parameters:

kaleoInstanceId - the primary key of the kaleo instance

Returns:

the kaleo instance

Throws:

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

getKaleoInstances

public static java.util.List<KaleoInstance> getKaleoInstances(int start,
                                                              int end)

Returns a range of all the kaleo instances.

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.workflow.kaleo.model.impl.KaleoInstanceModelImpl. 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 instances

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

Returns:

the range of kaleo instances

getKaleoInstances

public static java.util.List<KaleoInstance> getKaleoInstances(java.lang.Long userId,
                                                              java.lang.String assetClassName,
                                                              java.lang.Long assetClassPK,
                                                              java.lang.Boolean completed,
                                                              int start,
                                                              int end,
                                                              com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator,
                                                              com.liferay.portal.kernel.service.ServiceContext serviceContext)

getKaleoInstances

public static java.util.List<KaleoInstance> getKaleoInstances(java.lang.Long userId,
                                                              java.lang.String[] assetClassNames,
                                                              java.lang.Boolean completed,
                                                              int start,
                                                              int end,
                                                              com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator,
                                                              com.liferay.portal.kernel.service.ServiceContext serviceContext)

getKaleoInstances

public static java.util.List<KaleoInstance> getKaleoInstances(java.lang.String kaleoDefinitionName,
                                                              int kaleoDefinitionVersion,
                                                              boolean completed,
                                                              int start,
                                                              int end,
                                                              com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator,
                                                              com.liferay.portal.kernel.service.ServiceContext serviceContext)

getKaleoInstancesCount

public static int getKaleoInstancesCount()

Returns the number of kaleo instances.

Returns:

the number of kaleo instances

getKaleoInstancesCount

public static int getKaleoInstancesCount(long kaleoDefinitionId,
                                         boolean completed)

getKaleoInstancesCount

public static int getKaleoInstancesCount(java.lang.Long userId,
                                         java.lang.String assetClassName,
                                         java.lang.Long assetClassPK,
                                         java.lang.Boolean completed,
                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)

getKaleoInstancesCount

public static int getKaleoInstancesCount(java.lang.Long userId,
                                         java.lang.String[] assetClassNames,
                                         java.lang.Boolean completed,
                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)

getKaleoInstancesCount

public static int getKaleoInstancesCount(java.lang.String kaleoDefinitionName,
                                         int kaleoDefinitionVersion,
                                         boolean completed,
                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)

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

search

public static java.util.List<KaleoInstance> search(java.lang.Long userId,
                                                   java.lang.String assetType,
                                                   java.lang.String nodeName,
                                                   java.lang.String kaleoDefinitionName,
                                                   java.lang.Boolean completed,
                                                   int start,
                                                   int end,
                                                   com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator,
                                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)

searchCount

public static int searchCount(java.lang.Long userId,
                              java.lang.String assetType,
                              java.lang.String nodeName,
                              java.lang.String kaleoDefinitionName,
                              java.lang.Boolean completed,
                              com.liferay.portal.kernel.service.ServiceContext serviceContext)

updateKaleoInstance

public static KaleoInstance updateKaleoInstance(KaleoInstance kaleoInstance)

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

Parameters:

kaleoInstance - the kaleo instance

Returns:

the kaleo instance that was updated

updateKaleoInstance

public static KaleoInstance updateKaleoInstance(long kaleoInstanceId,
                                                java.util.Map<java.lang.String,java.io.Serializable> workflowContext,
                                                com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static KaleoInstanceLocalService getService()