com.liferay.calendar.service.CalendarLocalService 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.Calendar;
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 java.util.Locale;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for Calendar. 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 CalendarLocalServiceUtil
* @generated
*/
@CTAware
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface CalendarLocalService
extends BaseLocalService, CTService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.calendar.service.impl.CalendarLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the calendar local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link CalendarLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the calendar to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CalendarLocalServiceImpl 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 calendar the calendar
* @return the calendar that was added
*/
@Indexable(type = IndexableType.REINDEX)
public Calendar addCalendar(Calendar calendar);
@Indexable(type = IndexableType.REINDEX)
public Calendar addCalendar(
long userId, long groupId, long calendarResourceId,
Map nameMap, Map descriptionMap,
String timeZoneId, int color, boolean defaultCalendar,
boolean enableComments, boolean enableRatings,
ServiceContext serviceContext)
throws PortalException;
/**
* Creates a new calendar with the primary key. Does not add the calendar to the database.
*
* @param calendarId the primary key for the new calendar
* @return the new calendar
*/
@Transactional(enabled = false)
public Calendar createCalendar(long calendarId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Deletes the calendar from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CalendarLocalServiceImpl 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 calendar the calendar
* @return the calendar that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(
action = SystemEventConstants.ACTION_SKIP,
type = SystemEventConstants.TYPE_DELETE
)
public Calendar deleteCalendar(Calendar calendar) throws PortalException;
/**
* Deletes the calendar with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CalendarLocalServiceImpl 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 calendarId the primary key of the calendar
* @return the calendar that was removed
* @throws PortalException if a calendar with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public Calendar deleteCalendar(long calendarId) throws PortalException;
/**
* @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.CalendarModelImpl.
*
*
* @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.CalendarModelImpl.
*
*
* @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);
public String exportCalendar(long calendarId, String type) throws Exception;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Calendar fetchCalendar(long calendarId);
/**
* Returns the calendar matching the UUID and group.
*
* @param uuid the calendar's UUID
* @param groupId the primary key of the group
* @return the matching calendar, or null if a matching calendar could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Calendar fetchCalendarByUuidAndGroupId(String uuid, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Calendar fetchGroupCalendar(
long companyId, long groupId, String name);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
/**
* Returns the calendar with the primary key.
*
* @param calendarId the primary key of the calendar
* @return the calendar
* @throws PortalException if a calendar with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Calendar getCalendar(long calendarId) throws PortalException;
/**
* Returns the calendar matching the UUID and group.
*
* @param uuid the calendar's UUID
* @param groupId the primary key of the group
* @return the matching calendar
* @throws PortalException if a matching calendar could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Calendar getCalendarByUuidAndGroupId(String uuid, long groupId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCalendarResourceCalendars(
long groupId, long calendarResourceId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCalendarResourceCalendars(
long groupId, long calendarResourceId, boolean defaultCalendar);
/**
* Returns a range of all the calendars.
*
*
* 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.CalendarModelImpl.
*
*
* @param start the lower bound of the range of calendars
* @param end the upper bound of the range of calendars (not inclusive)
* @return the range of calendars
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCalendars(int start, int end);
/**
* Returns all the calendars matching the UUID and company.
*
* @param uuid the UUID of the calendars
* @param companyId the primary key of the company
* @return the matching calendars, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCalendarsByUuidAndCompanyId(
String uuid, long companyId);
/**
* Returns a range of calendars matching the UUID and company.
*
* @param uuid the UUID of the calendars
* @param companyId the primary key of the company
* @param start the lower bound of the range of calendars
* @param end the upper bound of the range of calendars (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching calendars, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCalendarsByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of calendars.
*
* @return the number of calendars
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCalendarsCount();
@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;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasStagingCalendar(Calendar calendar) throws PortalException;
public void importCalendar(long calendarId, String data, String type)
throws Exception;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean isStagingCalendar(Calendar calendar);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List search(
long companyId, long[] groupIds, long[] calendarResourceIds,
String keywords, boolean andOperator, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List search(
long companyId, long[] groupIds, long[] calendarResourceIds,
String name, String description, boolean andOperator, int start,
int end, OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(
long companyId, long[] groupIds, long[] calendarResourceIds,
String keywords, boolean andOperator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(
long companyId, long[] groupIds, long[] calendarResourceIds,
String name, String description, boolean andOperator);
/**
* Updates the calendar in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CalendarLocalServiceImpl 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 calendar the calendar
* @return the calendar that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public Calendar updateCalendar(Calendar calendar);
public void updateCalendar(long calendarId, boolean defaultCalendar)
throws PortalException;
public Calendar updateCalendar(
long calendarId, Map nameMap,
Map descriptionMap, int color,
ServiceContext serviceContext)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public Calendar updateCalendar(
long calendarId, Map nameMap,
Map descriptionMap, String timeZoneId, int color,
boolean defaultCalendar, boolean enableComments,
boolean enableRatings, ServiceContext serviceContext)
throws PortalException;
public Calendar updateColor(
long calendarId, int color, 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;
}