com.liferay.calendar.service.CalendarNotificationTemplateLocalService Maven / Gradle / Ivy
The newest version!
/**
* 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.calendar.service;
import com.liferay.calendar.model.CalendarNotificationTemplate;
import com.liferay.calendar.notification.NotificationTemplateType;
import com.liferay.calendar.notification.NotificationType;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.petra.function.UnsafeFunction;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.change.tracking.CTAware;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery;
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.SystemEventConstants;
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.service.change.tracking.CTService;
import com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence;
import com.liferay.portal.kernel.systemevent.SystemEvent;
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.List;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for CalendarNotificationTemplate. 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 Eduardo Lundgren
* @see CalendarNotificationTemplateLocalServiceUtil
* @generated
*/
@CTAware
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface CalendarNotificationTemplateLocalService
extends BaseLocalService, CTService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.calendar.service.impl.CalendarNotificationTemplateLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the calendar notification template local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link CalendarNotificationTemplateLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the calendar notification template to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CalendarNotificationTemplateLocalServiceImpl 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 calendarNotificationTemplate the calendar notification template
* @return the calendar notification template that was added
*/
@Indexable(type = IndexableType.REINDEX)
public CalendarNotificationTemplate addCalendarNotificationTemplate(
CalendarNotificationTemplate calendarNotificationTemplate);
public CalendarNotificationTemplate addCalendarNotificationTemplate(
long userId, long calendarId, NotificationType notificationType,
String notificationTypeSettings,
NotificationTemplateType notificationTemplateType, String subject,
String body, ServiceContext serviceContext)
throws PortalException;
/**
* Creates a new calendar notification template with the primary key. Does not add the calendar notification template to the database.
*
* @param calendarNotificationTemplateId the primary key for the new calendar notification template
* @return the new calendar notification template
*/
@Transactional(enabled = false)
public CalendarNotificationTemplate createCalendarNotificationTemplate(
long calendarNotificationTemplateId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Deletes the calendar notification template from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CalendarNotificationTemplateLocalServiceImpl 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 calendarNotificationTemplate the calendar notification template
* @return the calendar notification template that was removed
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public CalendarNotificationTemplate deleteCalendarNotificationTemplate(
CalendarNotificationTemplate calendarNotificationTemplate);
/**
* Deletes the calendar notification template with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CalendarNotificationTemplateLocalServiceImpl 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 calendarNotificationTemplateId the primary key of the calendar notification template
* @return the calendar notification template that was removed
* @throws PortalException if a calendar notification template with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public CalendarNotificationTemplate deleteCalendarNotificationTemplate(
long calendarNotificationTemplateId)
throws PortalException;
public void deleteCalendarNotificationTemplates(long calendarId);
/**
* @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.calendar.model.impl.CalendarNotificationTemplateModelImpl.
*
*
* @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.calendar.model.impl.CalendarNotificationTemplateModelImpl.
*
*
* @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 CalendarNotificationTemplate fetchCalendarNotificationTemplate(
long calendarNotificationTemplateId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CalendarNotificationTemplate fetchCalendarNotificationTemplate(
long calendarId, NotificationType notificationType,
NotificationTemplateType notificationTemplateType);
/**
* Returns the calendar notification template matching the UUID and group.
*
* @param uuid the calendar notification template's UUID
* @param groupId the primary key of the group
* @return the matching calendar notification template, or null if a matching calendar notification template could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CalendarNotificationTemplate
fetchCalendarNotificationTemplateByUuidAndGroupId(
String uuid, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
/**
* Returns the calendar notification template with the primary key.
*
* @param calendarNotificationTemplateId the primary key of the calendar notification template
* @return the calendar notification template
* @throws PortalException if a calendar notification template with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CalendarNotificationTemplate getCalendarNotificationTemplate(
long calendarNotificationTemplateId)
throws PortalException;
/**
* Returns the calendar notification template matching the UUID and group.
*
* @param uuid the calendar notification template's UUID
* @param groupId the primary key of the group
* @return the matching calendar notification template
* @throws PortalException if a matching calendar notification template could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CalendarNotificationTemplate
getCalendarNotificationTemplateByUuidAndGroupId(
String uuid, long groupId)
throws PortalException;
/**
* Returns a range of all the calendar notification templates.
*
*
* 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.calendar.model.impl.CalendarNotificationTemplateModelImpl.
*
*
* @param start the lower bound of the range of calendar notification templates
* @param end the upper bound of the range of calendar notification templates (not inclusive)
* @return the range of calendar notification templates
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCalendarNotificationTemplates(
int start, int end);
/**
* Returns all the calendar notification templates matching the UUID and company.
*
* @param uuid the UUID of the calendar notification templates
* @param companyId the primary key of the company
* @return the matching calendar notification templates, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getCalendarNotificationTemplatesByUuidAndCompanyId(
String uuid, long companyId);
/**
* Returns a range of calendar notification templates matching the UUID and company.
*
* @param uuid the UUID of the calendar notification templates
* @param companyId the primary key of the company
* @param start the lower bound of the range of calendar notification templates
* @param end the upper bound of the range of calendar notification templates (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching calendar notification templates, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getCalendarNotificationTemplatesByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of calendar notification templates.
*
* @return the number of calendar notification templates
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCalendarNotificationTemplatesCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@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 calendar notification template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CalendarNotificationTemplateLocalServiceImpl 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 calendarNotificationTemplate the calendar notification template
* @return the calendar notification template that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public CalendarNotificationTemplate updateCalendarNotificationTemplate(
CalendarNotificationTemplate calendarNotificationTemplate);
public CalendarNotificationTemplate updateCalendarNotificationTemplate(
long calendarNotificationTemplateId,
String notificationTypeSettings, String subject, String body,
ServiceContext serviceContext)
throws PortalException;
@Override
@Transactional(enabled = false)
public CTPersistence getCTPersistence();
@Override
@Transactional(enabled = false)
public Class getModelClass();
@Override
@Transactional(rollbackFor = Throwable.class)
public R updateWithUnsafeFunction(
UnsafeFunction, R, E>
updateUnsafeFunction)
throws E;
}