
com.liferay.dispatch.service.DispatchLogLocalService Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.dispatch.service;
import com.liferay.dispatch.executor.DispatchTaskStatus;
import com.liferay.dispatch.model.DispatchLog;
import com.liferay.petra.sql.dsl.query.DSLQuery;
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.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.Date;
import java.util.List;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for DispatchLog. 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 Matija Petanjek
* @see DispatchLogLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface DispatchLogLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.dispatch.service.impl.DispatchLogLocalServiceImpl
and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the dispatch log local service via injection or a org.osgi.util.tracker.ServiceTracker
. Use {@link DispatchLogLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the dispatch log to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect DispatchLogLocalServiceImpl 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.
*
*
* @param dispatchLog the dispatch log
* @return the dispatch log that was added
*/
@Indexable(type = IndexableType.REINDEX)
public DispatchLog addDispatchLog(DispatchLog dispatchLog);
public DispatchLog addDispatchLog(
long userId, long dispatchTriggerId, Date endDate, String error,
String output, Date startDate,
DispatchTaskStatus dispatchTaskStatus)
throws PortalException;
/**
* Creates a new dispatch log with the primary key. Does not add the dispatch log to the database.
*
* @param dispatchLogId the primary key for the new dispatch log
* @return the new dispatch log
*/
@Transactional(enabled = false)
public DispatchLog createDispatchLog(long dispatchLogId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Deletes the dispatch log from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect DispatchLogLocalServiceImpl 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.
*
*
* @param dispatchLog the dispatch log
* @return the dispatch log that was removed
*/
@Indexable(type = IndexableType.DELETE)
public DispatchLog deleteDispatchLog(DispatchLog dispatchLog);
/**
* Deletes the dispatch log with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect DispatchLogLocalServiceImpl 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.
*
*
* @param dispatchLogId the primary key of the dispatch log
* @return the dispatch log that was removed
* @throws PortalException if a dispatch log with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public DispatchLog deleteDispatchLog(long dispatchLogId)
throws PortalException;
public void deleteDispatchLogs(long dispatchTriggerId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public T dslQuery(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int dslQueryCount(DSLQuery dslQuery);
@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, then the query will include the default ORDER BY logic from com.liferay.dispatch.model.impl.DispatchLogModelImpl
.
*
*
* @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, then the query will include the default ORDER BY logic from com.liferay.dispatch.model.impl.DispatchLogModelImpl
.
*
*
* @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 DispatchLog fetchDispatchLog(long dispatchLogId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DispatchLog fetchLatestDispatchLog(long dispatchTriggerId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DispatchLog fetchLatestDispatchLog(
long dispatchTriggerId, DispatchTaskStatus dispatchTaskStatus);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
/**
* Returns the dispatch log with the primary key.
*
* @param dispatchLogId the primary key of the dispatch log
* @return the dispatch log
* @throws PortalException if a dispatch log with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DispatchLog getDispatchLog(long dispatchLogId)
throws PortalException;
/**
* Returns a range of all the dispatch logs.
*
*
* 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, then the query will include the default ORDER BY logic from com.liferay.dispatch.model.impl.DispatchLogModelImpl
.
*
*
* @param start the lower bound of the range of dispatch logs
* @param end the upper bound of the range of dispatch logs (not inclusive)
* @return the range of dispatch logs
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDispatchLogs(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDispatchLogs(
long dispatchTriggerId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDispatchLogs(
long dispatchTriggerId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of dispatch logs.
*
* @return the number of dispatch logs
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getDispatchLogsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getDispatchLogsCount(long dispatchTriggerId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* @throws PortalException
*/
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Updates the dispatch log in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect DispatchLogLocalServiceImpl 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.
*
*
* @param dispatchLog the dispatch log
* @return the dispatch log that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public DispatchLog updateDispatchLog(DispatchLog dispatchLog);
public DispatchLog updateDispatchLog(
long dispatchLogId, Date endDate, String error, String output,
DispatchTaskStatus dispatchTaskStatus)
throws PortalException;
}