com.liferay.portal.workflow.kaleo.service.KaleoInstanceLocalServiceUtil Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.workflow.kaleo.service;
import aQute.bnd.annotation.ProviderType;
import org.osgi.framework.Bundle;
import org.osgi.framework.FrameworkUtil;
import org.osgi.util.tracker.ServiceTracker;
/**
* Provides the local service utility for KaleoInstance. This utility wraps
* 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.
*
* @author Brian Wing Shun Chan
* @see KaleoInstanceLocalService
* @generated
*/
@ProviderType
public class KaleoInstanceLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to com.liferay.portal.workflow.kaleo.service.impl.KaleoInstanceLocalServiceImpl and rerun ServiceBuilder to regenerate this class.
*/
/**
* Adds the kaleo instance to the database. Also notifies the appropriate model listeners.
*
* @param kaleoInstance the kaleo instance
* @return the kaleo instance that was added
*/
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
addKaleoInstance(
com.liferay.portal.workflow.kaleo.model.KaleoInstance
kaleoInstance) {
return getService().addKaleoInstance(kaleoInstance);
}
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
addKaleoInstance(
long kaleoDefinitionVersionId, String kaleoDefinitionName,
int kaleoDefinitionVersion,
java.util.Map workflowContext,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().addKaleoInstance(
kaleoDefinitionVersionId, kaleoDefinitionName,
kaleoDefinitionVersion, workflowContext, serviceContext);
}
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
completeKaleoInstance(long kaleoInstanceId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().completeKaleoInstance(kaleoInstanceId);
}
/**
* Creates a new kaleo instance with the primary key. Does not add the kaleo instance to the database.
*
* @param kaleoInstanceId the primary key for the new kaleo instance
* @return the new kaleo instance
*/
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
createKaleoInstance(long kaleoInstanceId) {
return getService().createKaleoInstance(kaleoInstanceId);
}
public static void deleteCompanyKaleoInstances(long companyId) {
getService().deleteCompanyKaleoInstances(companyId);
}
public static void deleteKaleoDefinitionVersionKaleoInstances(
long kaleoDefinitionVersionId) {
getService().deleteKaleoDefinitionVersionKaleoInstances(
kaleoDefinitionVersionId);
}
/**
* Deletes the kaleo instance from the database. Also notifies the appropriate model listeners.
*
* @param kaleoInstance the kaleo instance
* @return the kaleo instance that was removed
*/
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
deleteKaleoInstance(
com.liferay.portal.workflow.kaleo.model.KaleoInstance
kaleoInstance) {
return getService().deleteKaleoInstance(kaleoInstance);
}
/**
* Deletes the kaleo instance with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param kaleoInstanceId the primary key of the kaleo instance
* @return the kaleo instance that was removed
* @throws PortalException if a kaleo instance with the primary key could not be found
*/
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
deleteKaleoInstance(long kaleoInstanceId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deleteKaleoInstance(kaleoInstanceId);
}
/**
* @throws PortalException
*/
public static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel(
com.liferay.portal.kernel.model.PersistedModel persistedModel)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deletePersistedModel(persistedModel);
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery
dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
return getService().dynamicQuery(dynamicQuery);
}
/**
* 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.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) {
return getService().dynamicQuery(dynamicQuery, start, end);
}
/**
* 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.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator) {
return getService().dynamicQuery(
dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection) {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
fetchKaleoInstance(long kaleoInstanceId) {
return getService().fetchKaleoInstance(kaleoInstanceId);
}
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
getActionableDynamicQuery() {
return getService().getActionableDynamicQuery();
}
public static
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
return getService().getIndexableActionableDynamicQuery();
}
/**
* Returns the kaleo instance with the primary key.
*
* @param kaleoInstanceId the primary key of the kaleo instance
* @return the kaleo instance
* @throws PortalException if a kaleo instance with the primary key could not be found
*/
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
getKaleoInstance(long kaleoInstanceId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getKaleoInstance(kaleoInstanceId);
}
/**
* 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 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.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.
*
*
* @param start the lower bound of the range of kaleo instances
* @param end the upper bound of the range of kaleo instances (not inclusive)
* @return the range of kaleo instances
*/
public static java.util.List
getKaleoInstances(int start, int end) {
return getService().getKaleoInstances(start, end);
}
public static java.util.List
getKaleoInstances(
Long userId, String assetClassName, Long assetClassPK,
Boolean completed, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
com.liferay.portal.kernel.service.ServiceContext
serviceContext) {
return getService().getKaleoInstances(
userId, assetClassName, assetClassPK, completed, start, end,
orderByComparator, serviceContext);
}
public static java.util.List
getKaleoInstances(
Long userId, String[] assetClassNames, Boolean completed,
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
com.liferay.portal.kernel.service.ServiceContext
serviceContext) {
return getService().getKaleoInstances(
userId, assetClassNames, completed, start, end, orderByComparator,
serviceContext);
}
public static java.util.List
getKaleoInstances(
String kaleoDefinitionName, int kaleoDefinitionVersion,
boolean completed, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
com.liferay.portal.kernel.service.ServiceContext
serviceContext) {
return getService().getKaleoInstances(
kaleoDefinitionName, kaleoDefinitionVersion, completed, start, end,
orderByComparator, serviceContext);
}
/**
* Returns the number of kaleo instances.
*
* @return the number of kaleo instances
*/
public static int getKaleoInstancesCount() {
return getService().getKaleoInstancesCount();
}
public static int getKaleoInstancesCount(
long kaleoDefinitionVersionId, boolean completed) {
return getService().getKaleoInstancesCount(
kaleoDefinitionVersionId, completed);
}
public static int getKaleoInstancesCount(
Long userId, String assetClassName, Long assetClassPK,
Boolean completed,
com.liferay.portal.kernel.service.ServiceContext serviceContext) {
return getService().getKaleoInstancesCount(
userId, assetClassName, assetClassPK, completed, serviceContext);
}
public static int getKaleoInstancesCount(
Long userId, String[] assetClassNames, Boolean completed,
com.liferay.portal.kernel.service.ServiceContext serviceContext) {
return getService().getKaleoInstancesCount(
userId, assetClassNames, completed, serviceContext);
}
public static int getKaleoInstancesCount(
String kaleoDefinitionName, int kaleoDefinitionVersion,
boolean completed,
com.liferay.portal.kernel.service.ServiceContext serviceContext) {
return getService().getKaleoInstancesCount(
kaleoDefinitionName, kaleoDefinitionVersion, completed,
serviceContext);
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public static String getOSGiServiceIdentifier() {
return getService().getOSGiServiceIdentifier();
}
public static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel(java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getPersistedModel(primaryKeyObj);
}
/**
* @deprecated As of Mueller (7.2.x), replaced by {@link #search(Long,
String, String, String, String, String, Boolean, int, int,
OrderByComparator, ServiceContext)}
*/
@Deprecated
public static java.util.List
search(
Long userId, String assetClassName, String nodeName,
String kaleoDefinitionName, Boolean completed, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
com.liferay.portal.kernel.service.ServiceContext serviceContext) {
return getService().search(
userId, assetClassName, nodeName, kaleoDefinitionName, completed,
start, end, orderByComparator, serviceContext);
}
public static java.util.List
search(
Long userId, String assetClassName, String assetTitle,
String assetDescription, String nodeName,
String kaleoDefinitionName, Boolean completed, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
com.liferay.portal.kernel.service.ServiceContext serviceContext) {
return getService().search(
userId, assetClassName, assetTitle, assetDescription, nodeName,
kaleoDefinitionName, completed, start, end, orderByComparator,
serviceContext);
}
/**
* @deprecated As of Mueller (7.2.x), replaced by {@link #searchCount(Long,
String, String, String, String, String, Boolean,
ServiceContext)}
*/
@Deprecated
public static int searchCount(
Long userId, String assetClassName, String nodeName,
String kaleoDefinitionName, Boolean completed,
com.liferay.portal.kernel.service.ServiceContext serviceContext) {
return getService().searchCount(
userId, assetClassName, nodeName, kaleoDefinitionName, completed,
serviceContext);
}
public static int searchCount(
Long userId, String assetClassName, String assetTitle,
String assetDescription, String nodeName, String kaleoDefinitionName,
Boolean completed,
com.liferay.portal.kernel.service.ServiceContext serviceContext) {
return getService().searchCount(
userId, assetClassName, assetTitle, assetDescription, nodeName,
kaleoDefinitionName, completed, serviceContext);
}
/**
* Updates the kaleo instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param kaleoInstance the kaleo instance
* @return the kaleo instance that was updated
*/
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
updateKaleoInstance(
com.liferay.portal.workflow.kaleo.model.KaleoInstance
kaleoInstance) {
return getService().updateKaleoInstance(kaleoInstance);
}
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
updateKaleoInstance(
long kaleoInstanceId, long rootKaleoInstanceTokenId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().updateKaleoInstance(
kaleoInstanceId, rootKaleoInstanceTokenId);
}
public static com.liferay.portal.workflow.kaleo.model.KaleoInstance
updateKaleoInstance(
long kaleoInstanceId,
java.util.Map workflowContext,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().updateKaleoInstance(
kaleoInstanceId, workflowContext, serviceContext);
}
public static KaleoInstanceLocalService getService() {
return _serviceTracker.getService();
}
private static ServiceTracker
_serviceTracker;
static {
Bundle bundle = FrameworkUtil.getBundle(
KaleoInstanceLocalService.class);
ServiceTracker
serviceTracker =
new ServiceTracker
(
bundle.getBundleContext(),
KaleoInstanceLocalService.class, null);
serviceTracker.open();
_serviceTracker = serviceTracker;
}
}