/**
* 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.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
* Provides the local service utility for UserNotificationEvent. This utility wraps
* {@link com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl} and is the
* primary access point for service operations in application layer code running
* on the local server. 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 UserNotificationEventLocalService
* @see com.liferay.portal.service.base.UserNotificationEventLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl
* @generated
*/
@ProviderType
public class UserNotificationEventLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() {
return getService().getActionableDynamicQuery();
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() {
return getService().getIndexableActionableDynamicQuery();
}
/**
* @throws PortalException
*/
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(
com.liferay.portal.kernel.model.PersistedModel persistedModel)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deletePersistedModel(persistedModel);
}
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getPersistedModel(primaryKeyObj);
}
/**
* 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
*/
public static com.liferay.portal.kernel.model.UserNotificationEvent addUserNotificationEvent(
com.liferay.portal.kernel.model.UserNotificationEvent userNotificationEvent) {
return getService().addUserNotificationEvent(userNotificationEvent);
}
public static com.liferay.portal.kernel.model.UserNotificationEvent addUserNotificationEvent(
long userId, boolean actionRequired,
com.liferay.portal.kernel.notifications.NotificationEvent notificationEvent)
throws com.liferay.portal.kernel.exception.PortalException {
return getService()
.addUserNotificationEvent(userId, actionRequired,
notificationEvent);
}
public static com.liferay.portal.kernel.model.UserNotificationEvent addUserNotificationEvent(
long userId,
com.liferay.portal.kernel.notifications.NotificationEvent notificationEvent)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().addUserNotificationEvent(userId, notificationEvent);
}
public static com.liferay.portal.kernel.model.UserNotificationEvent addUserNotificationEvent(
long userId, java.lang.String type, long timestamp, int deliveryType,
long deliverBy, java.lang.String payload, boolean actionRequired,
boolean archived, ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException {
return getService()
.addUserNotificationEvent(userId, type, timestamp,
deliveryType, deliverBy, payload, actionRequired, archived,
serviceContext);
}
public static com.liferay.portal.kernel.model.UserNotificationEvent addUserNotificationEvent(
long userId, java.lang.String type, long timestamp, int deliveryType,
long deliverBy, java.lang.String payload, boolean archived,
ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException {
return getService()
.addUserNotificationEvent(userId, type, timestamp,
deliveryType, deliverBy, payload, archived, serviceContext);
}
/**
* @deprecated As of 7.0.0, {@link #addUserNotificationEvent(long, String,
long, int, long, String, boolean, ServiceContext)}
*/
@Deprecated
public static com.liferay.portal.kernel.model.UserNotificationEvent addUserNotificationEvent(
long userId, java.lang.String type, long timestamp, long deliverBy,
java.lang.String payload, boolean archived,
ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException {
return getService()
.addUserNotificationEvent(userId, type, timestamp,
deliverBy, payload, archived, serviceContext);
}
/**
* 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
*/
public static com.liferay.portal.kernel.model.UserNotificationEvent createUserNotificationEvent(
long userNotificationEventId) {
return getService().createUserNotificationEvent(userNotificationEventId);
}
/**
* 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
*/
public static com.liferay.portal.kernel.model.UserNotificationEvent deleteUserNotificationEvent(
com.liferay.portal.kernel.model.UserNotificationEvent userNotificationEvent) {
return getService().deleteUserNotificationEvent(userNotificationEvent);
}
/**
* 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
*/
public static com.liferay.portal.kernel.model.UserNotificationEvent deleteUserNotificationEvent(
long userNotificationEventId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deleteUserNotificationEvent(userNotificationEventId);
}
public static com.liferay.portal.kernel.model.UserNotificationEvent fetchUserNotificationEvent(
long userNotificationEventId) {
return getService().fetchUserNotificationEvent(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 <code>null</code> if a matching user notification event could not be found
*/
public static com.liferay.portal.kernel.model.UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(
java.lang.String uuid, long companyId) {
return getService()
.fetchUserNotificationEventByUuidAndCompanyId(uuid, companyId);
}
/**
* 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
*/
public static com.liferay.portal.kernel.model.UserNotificationEvent getUserNotificationEvent(
long userNotificationEventId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getUserNotificationEvent(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
* @throws PortalException if a matching user notification event could not be found
*/
public static com.liferay.portal.kernel.model.UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(
java.lang.String uuid, long companyId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService()
.getUserNotificationEventByUuidAndCompanyId(uuid, companyId);
}
public static com.liferay.portal.kernel.model.UserNotificationEvent sendUserNotificationEvents(
long userId, java.lang.String portletId, int deliveryType,
boolean actionRequired,
com.liferay.portal.kernel.json.JSONObject notificationEventJSONObject)
throws com.liferay.portal.kernel.exception.PortalException {
return getService()
.sendUserNotificationEvents(userId, portletId, deliveryType,
actionRequired, notificationEventJSONObject);
}
public static com.liferay.portal.kernel.model.UserNotificationEvent sendUserNotificationEvents(
long userId, java.lang.String portletId, int deliveryType,
com.liferay.portal.kernel.json.JSONObject notificationEventJSONObject)
throws com.liferay.portal.kernel.exception.PortalException {
return getService()
.sendUserNotificationEvents(userId, portletId, deliveryType,
notificationEventJSONObject);
}
/**
* 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
*/
public static com.liferay.portal.kernel.model.UserNotificationEvent updateUserNotificationEvent(
com.liferay.portal.kernel.model.UserNotificationEvent userNotificationEvent) {
return getService().updateUserNotificationEvent(userNotificationEvent);
}
public static com.liferay.portal.kernel.model.UserNotificationEvent updateUserNotificationEvent(
java.lang.String uuid, long companyId, boolean archive) {
return getService().updateUserNotificationEvent(uuid, companyId, archive);
}
public static int getArchivedUserNotificationEventsCount(long userId,
boolean actionRequired, boolean archived) {
return getService()
.getArchivedUserNotificationEventsCount(userId,
actionRequired, archived);
}
public static int getArchivedUserNotificationEventsCount(long userId,
boolean archived) {
return getService()
.getArchivedUserNotificationEventsCount(userId, archived);
}
public static int getArchivedUserNotificationEventsCount(long userId,
int deliveryType, boolean actionRequired, boolean archived) {
return getService()
.getArchivedUserNotificationEventsCount(userId,
deliveryType, actionRequired, archived);
}
public static int getArchivedUserNotificationEventsCount(long userId,
int deliveryType, boolean archived) {
return getService()
.getArchivedUserNotificationEventsCount(userId,
deliveryType, archived);
}
public static int getDeliveredUserNotificationEventsCount(long userId,
boolean delivered) {
return getService()
.getDeliveredUserNotificationEventsCount(userId, delivered);
}
public static int getDeliveredUserNotificationEventsCount(long userId,
boolean delivered, boolean actionRequired) {
return getService()
.getDeliveredUserNotificationEventsCount(userId, delivered,
actionRequired);
}
public static int getDeliveredUserNotificationEventsCount(long userId,
int deliveryType, boolean delivered) {
return getService()
.getDeliveredUserNotificationEventsCount(userId,
deliveryType, delivered);
}
public static int getDeliveredUserNotificationEventsCount(long userId,
int deliveryType, boolean delivered, boolean actionRequired) {
return getService()
.getDeliveredUserNotificationEventsCount(userId,
deliveryType, delivered, actionRequired);
}
/**
* Returns the number of user notification events.
*
* @return the number of user notification events
*/
public static int getUserNotificationEventsCount() {
return getService().getUserNotificationEventsCount();
}
public static int getUserNotificationEventsCount(long userId) {
return getService().getUserNotificationEventsCount(userId);
}
public static int getUserNotificationEventsCount(long userId,
int deliveryType) {
return getService().getUserNotificationEventsCount(userId, deliveryType);
}
public static int getUserNotificationEventsCount(long userId,
java.lang.String type, int deliveryType, boolean archived) {
return getService()
.getUserNotificationEventsCount(userId, type, deliveryType,
archived);
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public static java.lang.String getOSGiServiceIdentifier() {
return getService().getOSGiServiceIdentifier();
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> addUserNotificationEvents(
long userId,
java.util.Collection<com.liferay.portal.kernel.notifications.NotificationEvent> notificationEvents)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().addUserNotificationEvents(userId, notificationEvents);
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
public static <T> java.util.List<T> dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
return getService().dynamicQuery(dynamicQuery);
}
/**
* Performs a dynamic query on the database and returns a range of the matching rows.
*
* <p>
* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.UserNotificationEventModelImpl}. If both <code>orderByComparator</code> 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.
* </p>
*
* @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
*/
public static <T> java.util.List<T> dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) {
return getService().dynamicQuery(dynamicQuery, start, end);
}
/**
* Performs a dynamic query on the database and returns an ordered range of the matching rows.
*
* <p>
* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.UserNotificationEventModelImpl}. If both <code>orderByComparator</code> 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.
* </p>
*
* @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 <code>null</code>)
* @return the ordered range of matching rows
*/
public static <T> java.util.List<T> dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) {
return getService()
.dynamicQuery(dynamicQuery, start, end, orderByComparator);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getArchivedUserNotificationEvents(
long userId, boolean actionRequired, boolean archived) {
return getService()
.getArchivedUserNotificationEvents(userId, actionRequired,
archived);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getArchivedUserNotificationEvents(
long userId, boolean actionRequired, boolean archived, int start,
int end) {
return getService()
.getArchivedUserNotificationEvents(userId, actionRequired,
archived, start, end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getArchivedUserNotificationEvents(
long userId, boolean archived) {
return getService().getArchivedUserNotificationEvents(userId, archived);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getArchivedUserNotificationEvents(
long userId, boolean archived, int start, int end) {
return getService()
.getArchivedUserNotificationEvents(userId, archived, start,
end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getArchivedUserNotificationEvents(
long userId, int deliveryType, boolean actionRequired, boolean archived) {
return getService()
.getArchivedUserNotificationEvents(userId, deliveryType,
actionRequired, archived);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getArchivedUserNotificationEvents(
long userId, int deliveryType, boolean actionRequired,
boolean archived, int start, int end) {
return getService()
.getArchivedUserNotificationEvents(userId, deliveryType,
actionRequired, archived, start, end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getArchivedUserNotificationEvents(
long userId, int deliveryType, boolean archived) {
return getService()
.getArchivedUserNotificationEvents(userId, deliveryType,
archived);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getArchivedUserNotificationEvents(
long userId, int deliveryType, boolean archived, int start, int end) {
return getService()
.getArchivedUserNotificationEvents(userId, deliveryType,
archived, start, end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
long userId, boolean delivered) {
return getService().getDeliveredUserNotificationEvents(userId, delivered);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
long userId, boolean delivered, boolean actionRequired) {
return getService()
.getDeliveredUserNotificationEvents(userId, delivered,
actionRequired);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
long userId, boolean delivered, boolean actionRequired, int start,
int end) {
return getService()
.getDeliveredUserNotificationEvents(userId, delivered,
actionRequired, start, end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
long userId, boolean delivered, int start, int end) {
return getService()
.getDeliveredUserNotificationEvents(userId, delivered,
start, end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
long userId, int deliveryType, boolean delivered) {
return getService()
.getDeliveredUserNotificationEvents(userId, deliveryType,
delivered);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
long userId, int deliveryType, boolean delivered, boolean actionRequired) {
return getService()
.getDeliveredUserNotificationEvents(userId, deliveryType,
delivered, actionRequired);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
long userId, int deliveryType, boolean delivered,
boolean actionRequired, int start, int end) {
return getService()
.getDeliveredUserNotificationEvents(userId, deliveryType,
delivered, actionRequired, start, end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
long userId, int deliveryType, boolean delivered, int start, int end) {
return getService()
.getDeliveredUserNotificationEvents(userId, deliveryType,
delivered, start, end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getTypeNotificationEvents(
java.lang.String type) {
return getService().getTypeNotificationEvents(type);
}
/**
* Returns a range of all the user notification events.
*
* <p>
* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.UserNotificationEventModelImpl}. If both <code>orderByComparator</code> 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.
* </p>
*
* @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
*/
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getUserNotificationEvents(
int start, int end) {
return getService().getUserNotificationEvents(start, end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getUserNotificationEvents(
long userId) {
return getService().getUserNotificationEvents(userId);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getUserNotificationEvents(
long userId, int deliveryType) {
return getService().getUserNotificationEvents(userId, deliveryType);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getUserNotificationEvents(
long userId, int deliveryType, int start, int end) {
return getService()
.getUserNotificationEvents(userId, deliveryType, start, end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> getUserNotificationEvents(
long userId, int start, int end) {
return getService().getUserNotificationEvents(userId, start, end);
}
public static java.util.List<com.liferay.portal.kernel.model.UserNotificationEvent> updateUserNotificationEvents(
java.util.Collection<java.lang.String> uuids, long companyId,
boolean archive) {
return getService()
.updateUserNotificationEvents(uuids, companyId, archive);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
return getService().dynamicQueryCount(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
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection) {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static void deleteUserNotificationEvent(java.lang.String uuid,
long companyId) {
getService().deleteUserNotificationEvent(uuid, companyId);
}
public static void deleteUserNotificationEvents(
java.util.Collection<java.lang.String> uuids, long companyId) {
getService().deleteUserNotificationEvents(uuids, companyId);
}
public static UserNotificationEventLocalService getService() {
if (_service == null) {
_service = (UserNotificationEventLocalService)PortalBeanLocatorUtil.locate(UserNotificationEventLocalService.class.getName());
ReferenceRegistry.registerReference(UserNotificationEventLocalServiceUtil.class,
"_service");
}
return _service;
}
private static UserNotificationEventLocalService _service;
}