com.liferay.portal.workflow.kaleo.service.KaleoTaskInstanceTokenLocalService 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 com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.workflow.kaleo.model.KaleoTaskAssignment;
import com.liferay.portal.workflow.kaleo.model.KaleoTaskInstanceToken;
import java.io.Serializable;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* Provides the local service interface for KaleoTaskInstanceToken. 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 KaleoTaskInstanceTokenLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface KaleoTaskInstanceTokenLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link KaleoTaskInstanceTokenLocalServiceUtil} to access the kaleo task instance token local service. Add custom service methods to com.liferay.portal.workflow.kaleo.service.impl.KaleoTaskInstanceTokenLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the kaleo task instance token to the database. Also notifies the appropriate model listeners.
*
* @param kaleoTaskInstanceToken the kaleo task instance token
* @return the kaleo task instance token that was added
*/
@Indexable(type = IndexableType.REINDEX)
public KaleoTaskInstanceToken addKaleoTaskInstanceToken(
KaleoTaskInstanceToken kaleoTaskInstanceToken);
@Indexable(type = IndexableType.REINDEX)
public KaleoTaskInstanceToken addKaleoTaskInstanceToken(
long kaleoInstanceTokenId, long kaleoTaskId, String kaleoTaskName,
Collection kaleoTaskAssignments, Date dueDate,
Map workflowContext,
ServiceContext serviceContext)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public KaleoTaskInstanceToken assignKaleoTaskInstanceToken(
long kaleoTaskInstanceTokenId, String assigneeClassName,
long assigneeClassPK, Map workflowContext,
ServiceContext serviceContext)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public KaleoTaskInstanceToken completeKaleoTaskInstanceToken(
long kaleoTaskInstanceTokenId, ServiceContext serviceContext)
throws PortalException;
/**
* Creates a new kaleo task instance token with the primary key. Does not add the kaleo task instance token to the database.
*
* @param kaleoTaskInstanceTokenId the primary key for the new kaleo task instance token
* @return the new kaleo task instance token
*/
@Transactional(enabled = false)
public KaleoTaskInstanceToken createKaleoTaskInstanceToken(
long kaleoTaskInstanceTokenId);
public void deleteCompanyKaleoTaskInstanceTokens(long companyId);
public void deleteKaleoDefinitionVersionKaleoTaskInstanceTokens(
long kaleoDefinitionVersionId);
public void deleteKaleoInstanceKaleoTaskInstanceTokens(
long kaleoInstanceId);
/**
* Deletes the kaleo task instance token from the database. Also notifies the appropriate model listeners.
*
* @param kaleoTaskInstanceToken the kaleo task instance token
* @return the kaleo task instance token that was removed
*/
@Indexable(type = IndexableType.DELETE)
public KaleoTaskInstanceToken deleteKaleoTaskInstanceToken(
KaleoTaskInstanceToken kaleoTaskInstanceToken);
/**
* Deletes the kaleo task instance token with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param kaleoTaskInstanceTokenId the primary key of the kaleo task instance token
* @return the kaleo task instance token that was removed
* @throws PortalException if a kaleo task instance token with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public KaleoTaskInstanceToken deleteKaleoTaskInstanceToken(
long kaleoTaskInstanceTokenId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(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.KaleoTaskInstanceTokenModelImpl. 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int 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.KaleoTaskInstanceTokenModelImpl. 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public KaleoTaskInstanceToken fetchKaleoTaskInstanceToken(
long kaleoTaskInstanceTokenId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCompanyKaleoTaskInstanceTokens(
long companyId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCompanyKaleoTaskInstanceTokensCount(long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the kaleo task instance token with the primary key.
*
* @param kaleoTaskInstanceTokenId the primary key of the kaleo task instance token
* @return the kaleo task instance token
* @throws PortalException if a kaleo task instance token with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public KaleoTaskInstanceToken getKaleoTaskInstanceToken(
long kaleoTaskInstanceTokenId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKaleoTaskInstanceTokens(
Boolean completed, int start, int end,
OrderByComparator orderByComparator,
ServiceContext serviceContext);
/**
* Returns a range of all the kaleo task instance tokens.
*
*
* 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.KaleoTaskInstanceTokenModelImpl. 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 task instance tokens
* @param end the upper bound of the range of kaleo task instance tokens (not inclusive)
* @return the range of kaleo task instance tokens
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKaleoTaskInstanceTokens(
int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKaleoTaskInstanceTokens(
List roleIds, Boolean completed, int start, int end,
OrderByComparator orderByComparator,
ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKaleoTaskInstanceTokens(
long kaleoInstanceId, Boolean completed, int start, int end,
OrderByComparator orderByComparator,
ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public KaleoTaskInstanceToken getKaleoTaskInstanceTokens(
long kaleoInstanceId, long kaleoTaskId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKaleoTaskInstanceTokens(
String assigneeClassName, long assigneeClassPK, Boolean completed,
int start, int end,
OrderByComparator orderByComparator,
ServiceContext serviceContext);
/**
* Returns the number of kaleo task instance tokens.
*
* @return the number of kaleo task instance tokens
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKaleoTaskInstanceTokensCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKaleoTaskInstanceTokensCount(
Boolean completed, ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKaleoTaskInstanceTokensCount(
List roleIds, Boolean completed, ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKaleoTaskInstanceTokensCount(
long kaleoInstanceId, Boolean completed, ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKaleoTaskInstanceTokensCount(
String assigneeClassName, long assigneeClassPK, Boolean completed,
ServiceContext serviceContext);
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getSubmittingUserKaleoTaskInstanceTokens(
long userId, Boolean completed, int start, int end,
OrderByComparator orderByComparator,
ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getSubmittingUserKaleoTaskInstanceTokensCount(
long userId, Boolean completed, ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasPendingKaleoTaskForms(long kaleoTaskInstanceTokenId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List search(
String keywords, Boolean completed, Boolean searchByUserRoles,
int start, int end,
OrderByComparator orderByComparator,
ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List search(
String taskName, String assetType, Long[] assetPrimaryKeys,
Date dueDateGT, Date dueDateLT, Boolean completed,
Boolean searchByUserRoles, boolean andOperator, int start, int end,
OrderByComparator orderByComparator,
ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List search(
String assetTitle, String taskName, String[] assetTypes,
Long[] assetPrimaryKeys, Date dueDateGT, Date dueDateLT,
Boolean completed, Boolean searchByUserRoles, boolean andOperator,
int start, int end,
OrderByComparator orderByComparator,
ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List search(
String keywords, String[] assetTypes, Boolean completed,
Boolean searchByUserRoles, int start, int end,
OrderByComparator orderByComparator,
ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(
String keywords, Boolean completed, Boolean searchByUserRoles,
ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(
String taskName, String assetType, Long[] assetPrimaryKeys,
Date dueDateGT, Date dueDateLT, Boolean completed,
Boolean searchByUserRoles, boolean andOperator,
ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(
String assetTitle, String taskName, String[] assetTypes,
Long[] assetPrimaryKeys, Date dueDateGT, Date dueDateLT,
Boolean completed, Boolean searchByUserRoles, boolean andOperator,
ServiceContext serviceContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(
String keywords, String[] assetTypes, Boolean completed,
Boolean searchByUserRoles, ServiceContext serviceContext);
public KaleoTaskInstanceToken updateDueDate(
long kaleoTaskInstanceTokenId, Date dueDate,
ServiceContext serviceContext)
throws PortalException;
/**
* Updates the kaleo task instance token in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param kaleoTaskInstanceToken the kaleo task instance token
* @return the kaleo task instance token that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public KaleoTaskInstanceToken updateKaleoTaskInstanceToken(
KaleoTaskInstanceToken kaleoTaskInstanceToken);
}