com.liferay.portal.kernel.service.TicketLocalService Maven / Gradle / Ivy
Show all versions of com.liferay.portal.kernel Show documentation
/**
* 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.portal.kernel.service;
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.model.Ticket;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.spring.osgi.OSGiBeanProperties;
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 Ticket. 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 TicketLocalServiceUtil
* @generated
*/
@OSGiBeanProperties(
property = {"model.class.name=com.liferay.portal.kernel.model.Ticket"}
)
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface TicketLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.portal.service.impl.TicketLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the ticket local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link TicketLocalServiceUtil} if injection and service tracking are not available.
*/
public Ticket addDistinctTicket(
long companyId, String className, long classPK, int type,
String extraInfo, Date expirationDate, ServiceContext serviceContext);
public Ticket addTicket(
long companyId, String className, long classPK, int type,
String extraInfo, Date expirationDate, ServiceContext serviceContext);
/**
* Adds the ticket to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect TicketLocalServiceImpl 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 ticket the ticket
* @return the ticket that was added
*/
@Indexable(type = IndexableType.REINDEX)
public Ticket addTicket(Ticket ticket);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Creates a new ticket with the primary key. Does not add the ticket to the database.
*
* @param ticketId the primary key for the new ticket
* @return the new ticket
*/
@Transactional(enabled = false)
public Ticket createTicket(long ticketId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the ticket with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect TicketLocalServiceImpl 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 ticketId the primary key of the ticket
* @return the ticket that was removed
* @throws PortalException if a ticket with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public Ticket deleteTicket(long ticketId) throws PortalException;
/**
* Deletes the ticket from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect TicketLocalServiceImpl 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 ticket the ticket
* @return the ticket that was removed
*/
@Indexable(type = IndexableType.DELETE)
public Ticket deleteTicket(Ticket ticket);
public void deleteTickets(long companyId, String className, long classPK);
public void deleteTickets(
long companyId, String className, long classPK, int type);
@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.portal.model.impl.TicketModelImpl.
*
*
* @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.portal.model.impl.TicketModelImpl.
*
*
* @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 Ticket fetchTicket(long ticketId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Ticket fetchTicket(String key);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@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;
/**
* Returns the ticket with the primary key.
*
* @param ticketId the primary key of the ticket
* @return the ticket
* @throws PortalException if a ticket with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Ticket getTicket(long ticketId) throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Ticket getTicket(String key) throws PortalException;
/**
* Returns a range of all the tickets.
*
*
* 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.portal.model.impl.TicketModelImpl.
*
*
* @param start the lower bound of the range of tickets
* @param end the upper bound of the range of tickets (not inclusive)
* @return the range of tickets
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getTickets(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getTickets(
long companyId, String className, long classPK);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getTickets(
long companyId, String className, long classPK, int type);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getTickets(String className, long classPK, int type);
/**
* Returns the number of tickets.
*
* @return the number of tickets
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getTicketsCount();
public Ticket updateTicket(
long ticketId, String className, long classPK, int type,
String extraInfo, Date expirationDate)
throws PortalException;
/**
* Updates the ticket in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect TicketLocalServiceImpl 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 ticket the ticket
* @return the ticket that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public Ticket updateTicket(Ticket ticket);
}