com.liferay.portal.kernel.service.UserNotificationEventLocalService 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.kernel.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.json.JSONObject;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.model.UserNotificationEvent;
import com.liferay.portal.kernel.notifications.NotificationEvent;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
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.Collection;
import java.util.List;
/**
* Provides the local service interface for UserNotificationEvent. 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 UserNotificationEventLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface UserNotificationEventLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link UserNotificationEventLocalServiceUtil} to access the user notification event local service. Add custom service methods to com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
public UserNotificationEvent addUserNotificationEvent(
long userId, boolean actionRequired,
NotificationEvent notificationEvent)
throws PortalException;
public UserNotificationEvent addUserNotificationEvent(
long userId, NotificationEvent notificationEvent)
throws PortalException;
public UserNotificationEvent addUserNotificationEvent(
long userId, String type, long timestamp, int deliveryType,
long deliverBy, String payload, boolean actionRequired,
boolean archived, ServiceContext serviceContext)
throws PortalException;
public UserNotificationEvent addUserNotificationEvent(
long userId, String type, long timestamp, int deliveryType,
long deliverBy, String payload, boolean archived,
ServiceContext serviceContext)
throws PortalException;
/**
* @deprecated As of Wilberforce (7.0.x), {@link
#addUserNotificationEvent(long, String, long, int, long,
String, boolean, ServiceContext)}
*/
@Deprecated
public UserNotificationEvent addUserNotificationEvent(
long userId, String type, long timestamp, long deliverBy,
String payload, boolean archived, ServiceContext serviceContext)
throws PortalException;
/**
* Adds the user notification event to the database. Also notifies the appropriate model listeners.
*
* @param userNotificationEvent the user notification event
* @return the user notification event that was added
*/
@Indexable(type = IndexableType.REINDEX)
public UserNotificationEvent addUserNotificationEvent(
UserNotificationEvent userNotificationEvent);
public List addUserNotificationEvents(
long userId, Collection notificationEvents)
throws PortalException;
public void archiveUserNotificationEvents(
long userId, int deliveryType, boolean actionRequired)
throws PortalException;
/**
* Creates a new user notification event with the primary key. Does not add the user notification event to the database.
*
* @param userNotificationEventId the primary key for the new user notification event
* @return the new user notification event
*/
@Transactional(enabled = false)
public UserNotificationEvent createUserNotificationEvent(
long userNotificationEventId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the user notification event with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param userNotificationEventId the primary key of the user notification event
* @return the user notification event that was removed
* @throws PortalException if a user notification event with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public UserNotificationEvent deleteUserNotificationEvent(
long userNotificationEventId)
throws PortalException;
public void deleteUserNotificationEvent(String uuid, long companyId);
/**
* Deletes the user notification event from the database. Also notifies the appropriate model listeners.
*
* @param userNotificationEvent the user notification event
* @return the user notification event that was removed
*/
@Indexable(type = IndexableType.DELETE)
public UserNotificationEvent deleteUserNotificationEvent(
UserNotificationEvent userNotificationEvent);
public void deleteUserNotificationEvents(
Collection uuids, long companyId);
public void deleteUserNotificationEvents(long userId);
@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.model.impl.UserNotificationEventModelImpl. 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.model.impl.UserNotificationEventModelImpl. 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 UserNotificationEvent fetchUserNotificationEvent(
long userNotificationEventId);
/**
* Returns the user notification event with the matching UUID and company.
*
* @param uuid the user notification event's UUID
* @param companyId the primary key of the company
* @return the matching user notification event, or null if a matching user notification event could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(
String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArchivedUserNotificationEvents(
long userId, boolean archived);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArchivedUserNotificationEvents(
long userId, boolean actionRequired, boolean archived);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArchivedUserNotificationEvents(
long userId, boolean actionRequired, boolean archived, int start,
int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArchivedUserNotificationEvents(
long userId, boolean archived, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArchivedUserNotificationEvents(
long userId, int deliveryType, boolean archived);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArchivedUserNotificationEvents(
long userId, int deliveryType, boolean actionRequired,
boolean archived);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArchivedUserNotificationEvents(
long userId, int deliveryType, boolean actionRequired, boolean archived,
int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArchivedUserNotificationEvents(
long userId, int deliveryType, boolean actionRequired, boolean archived,
int start, int end, OrderByComparator obc);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArchivedUserNotificationEvents(
long userId, int deliveryType, boolean archived, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getArchivedUserNotificationEventsCount(
long userId, boolean archived);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getArchivedUserNotificationEventsCount(
long userId, boolean actionRequired, boolean archived);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getArchivedUserNotificationEventsCount(
long userId, int deliveryType, boolean archived);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getArchivedUserNotificationEventsCount(
long userId, int deliveryType, boolean actionRequired,
boolean archived);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDeliveredUserNotificationEvents(
long userId, boolean delivered);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDeliveredUserNotificationEvents(
long userId, boolean delivered, boolean actionRequired);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDeliveredUserNotificationEvents(
long userId, boolean delivered, boolean actionRequired, int start,
int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDeliveredUserNotificationEvents(
long userId, boolean delivered, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDeliveredUserNotificationEvents(
long userId, int deliveryType, boolean delivered);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDeliveredUserNotificationEvents(
long userId, int deliveryType, boolean delivered,
boolean actionRequired);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDeliveredUserNotificationEvents(
long userId, int deliveryType, boolean delivered,
boolean actionRequired, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDeliveredUserNotificationEvents(
long userId, int deliveryType, boolean delivered,
boolean actionRequired, int start, int end,
OrderByComparator obc);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDeliveredUserNotificationEvents(
long userId, int deliveryType, boolean delivered, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getDeliveredUserNotificationEventsCount(
long userId, boolean delivered);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getDeliveredUserNotificationEventsCount(
long userId, boolean delivered, boolean actionRequired);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getDeliveredUserNotificationEventsCount(
long userId, int deliveryType, boolean delivered);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getDeliveredUserNotificationEventsCount(
long userId, int deliveryType, boolean delivered,
boolean actionRequired);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* 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 getTypeNotificationEvents(String type);
/**
* Returns the user notification event with the primary key.
*
* @param userNotificationEventId the primary key of the user notification event
* @return the user notification event
* @throws PortalException if a user notification event with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public UserNotificationEvent getUserNotificationEvent(
long userNotificationEventId)
throws PortalException;
/**
* Returns the user notification event with the matching UUID and company.
*
* @param uuid the user notification event's UUID
* @param companyId the primary key of the company
* @return the matching user notification event
* @throws PortalException if a matching user notification event could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
/**
* Returns a range of all the user notification events.
*
*
* 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.model.impl.UserNotificationEventModelImpl. 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 user notification events
* @param end the upper bound of the range of user notification events (not inclusive)
* @return the range of user notification events
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserNotificationEvents(
int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserNotificationEvents(long userId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserNotificationEvents(
long userId, int deliveryType);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserNotificationEvents(
long userId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserNotificationEvents(
long userId, int deliveryType, int start, int end);
/**
* Returns the number of user notification events.
*
* @return the number of user notification events
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserNotificationEventsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserNotificationEventsCount(long userId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserNotificationEventsCount(long userId, int deliveryType);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserNotificationEventsCount(
long userId, String type, int deliveryType, boolean archived);
public UserNotificationEvent sendUserNotificationEvents(
long userId, String portletId, int deliveryType,
boolean actionRequired, JSONObject notificationEventJSONObject)
throws PortalException;
public UserNotificationEvent sendUserNotificationEvents(
long userId, String portletId, int deliveryType,
JSONObject notificationEventJSONObject)
throws PortalException;
public UserNotificationEvent updateUserNotificationEvent(
String uuid, long companyId, boolean archive);
/**
* Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param userNotificationEvent the user notification event
* @return the user notification event that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public UserNotificationEvent updateUserNotificationEvent(
UserNotificationEvent userNotificationEvent);
public List updateUserNotificationEvents(
Collection uuids, long companyId, boolean archive);
}