Class KaleoInstanceLocalServiceUtil
com.liferay.portal.workflow.kaleo.service.impl.KaleoInstanceLocalServiceImpl
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 KaleoInstance
addKaleoInstance
(long kaleoDefinitionId, long kaleoDefinitionVersionId, String kaleoDefinitionName, int kaleoDefinitionVersion, Map<String, Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KaleoInstance
addKaleoInstance
(KaleoInstance kaleoInstance) Adds the kaleo instance to the database.static KaleoInstance
completeKaleoInstance
(long kaleoInstanceId) static KaleoInstance
createKaleoInstance
(long kaleoInstanceId) Creates a new kaleo instance with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static void
deleteCompanyKaleoInstances
(long companyId) static void
deleteKaleoDefinitionVersionKaleoInstances
(long kaleoDefinitionVersionId) static KaleoInstance
deleteKaleoInstance
(long kaleoInstanceId) Deletes the kaleo instance with the primary key from the database.static KaleoInstance
deleteKaleoInstance
(KaleoInstance kaleoInstance) Deletes the kaleo instance from the database.static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <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 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 KaleoInstance
fetchKaleoInstance
(long kaleoInstanceId, long companyId, long userId) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static int
getKaleoDefinitionKaleoInstancesCount
(long kaleoDefinitionId, boolean completed) static KaleoInstance
getKaleoInstance
(long kaleoInstanceId) Returns the kaleo instance with the primary key.static List<KaleoInstance>
getKaleoInstances
(int start, int end) Returns a range of all the kaleo instances.static List<KaleoInstance>
getKaleoInstances
(Long userId, String[] assetClassNames, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) static List<KaleoInstance>
getKaleoInstances
(Long userId, String assetClassName, Long assetClassPK, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) static List<KaleoInstance>
getKaleoInstances
(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
Returns the number of kaleo instances.static int
getKaleoInstancesCount
(long kaleoDefinitionVersionId, boolean completed) static int
getKaleoInstancesCount
(Long userId, String[] assetClassNames, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext) static int
getKaleoInstancesCount
(Long userId, String assetClassName, Long assetClassPK, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext) static int
getKaleoInstancesCount
(String kaleoDefinitionName, int kaleoDefinitionVersion, boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext) static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static KaleoInstanceLocalService
static List<KaleoInstance>
search
(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) static int
searchCount
(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext) static com.liferay.portal.kernel.search.BaseModelSearchResult<KaleoInstance>
searchKaleoInstances
(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, boolean searchByActiveWorkflowHandlers, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KaleoInstance
updateActive
(long userId, long kaleoInstanceId, boolean active) static KaleoInstance
updateKaleoInstance
(long kaleoInstanceId, long rootKaleoInstanceTokenId) static KaleoInstance
updateKaleoInstance
(long kaleoInstanceId, Map<String, Serializable> workflowContext) static KaleoInstance
updateKaleoInstance
(KaleoInstance kaleoInstance) Updates the kaleo instance in the database or adds it if it does not yet exist.
-
Constructor Details
-
KaleoInstanceLocalServiceUtil
public KaleoInstanceLocalServiceUtil()
-
-
Method Details
-
addKaleoInstance
Adds the kaleo instance to the database. Also notifies the appropriate model listeners.Important: Inspect KaleoInstanceLocalServiceImpl 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:
kaleoInstance
- the kaleo instance- Returns:
- the kaleo instance that was added
-
addKaleoInstance
public static KaleoInstance addKaleoInstance(long kaleoDefinitionId, long kaleoDefinitionVersionId, String kaleoDefinitionName, int kaleoDefinitionVersion, Map<String, 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
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
-
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
-
deleteCompanyKaleoInstances
public static void deleteCompanyKaleoInstances(long companyId) -
deleteKaleoDefinitionVersionKaleoInstances
public static void deleteKaleoDefinitionVersionKaleoInstances(long kaleoDefinitionVersionId) -
deleteKaleoInstance
Deletes the kaleo instance from the database. Also notifies the appropriate model listeners.Important: Inspect KaleoInstanceLocalServiceImpl 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:
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.Important: Inspect KaleoInstanceLocalServiceImpl 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:
kaleoInstanceId
- the primary key of the kaleo instance- Returns:
- the kaleo instance that was removed
- Throws:
com.liferay.portal.kernel.exception.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:
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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.workflow.kaleo.model.impl.KaleoInstanceModelImpl
.- 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.workflow.kaleo.model.impl.KaleoInstanceModelImpl
.- 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
-
fetchKaleoInstance
-
fetchKaleoInstance
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getKaleoDefinitionKaleoInstancesCount
public static int getKaleoDefinitionKaleoInstancesCount(long kaleoDefinitionId, boolean completed) -
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:
com.liferay.portal.kernel.exception.PortalException
- if a kaleo instance with the primary key could not be found
-
getKaleoInstances
Returns a range of all the kaleo instances.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.workflow.kaleo.model.impl.KaleoInstanceModelImpl
.- Parameters:
start
- the lower bound of the range of kaleo instancesend
- the upper bound of the range of kaleo instances (not inclusive)- Returns:
- the range of kaleo instances
-
getKaleoInstances
public static List<KaleoInstance> getKaleoInstances(Long userId, String assetClassName, Long assetClassPK, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKaleoInstances
public static List<KaleoInstance> getKaleoInstances(Long userId, String[] assetClassNames, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKaleoInstances
public static List<KaleoInstance> getKaleoInstances(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) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKaleoInstancesCount
public static int getKaleoInstancesCount()Returns the number of kaleo instances.- Returns:
- the number of kaleo instances
-
getKaleoInstancesCount
public static int getKaleoInstancesCount(long kaleoDefinitionVersionId, boolean completed) -
getKaleoInstancesCount
-
getKaleoInstancesCount
-
getKaleoInstancesCount
public static int getKaleoInstancesCount(String kaleoDefinitionName, int kaleoDefinitionVersion, boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
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
-
search
public static List<KaleoInstance> search(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
searchCount
-
searchKaleoInstances
public static com.liferay.portal.kernel.search.BaseModelSearchResult<KaleoInstance> searchKaleoInstances(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, boolean searchByActiveWorkflowHandlers, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateActive
public static KaleoInstance updateActive(long userId, long kaleoInstanceId, boolean active) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKaleoInstance
Updates the kaleo instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect KaleoInstanceLocalServiceImpl 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:
kaleoInstance
- the kaleo instance- Returns:
- the kaleo instance that was updated
-
updateKaleoInstance
public static KaleoInstance updateKaleoInstance(long kaleoInstanceId, long rootKaleoInstanceTokenId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKaleoInstance
public static KaleoInstance updateKaleoInstance(long kaleoInstanceId, Map<String, Serializable> workflowContext) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-