com.liferay.portal.service.UserNotificationEventLocalServiceUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 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.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.
*/
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().addUserNotificationEvent(userNotificationEvent);
}
/**
* 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.model.UserNotificationEvent createUserNotificationEvent(
long userNotificationEventId) {
return getService().createUserNotificationEvent(userNotificationEventId);
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserNotificationEvent deleteUserNotificationEvent(
long userNotificationEventId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().deleteUserNotificationEvent(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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserNotificationEvent deleteUserNotificationEvent(
com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().deleteUserNotificationEvent(userNotificationEvent);
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().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 {@link 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 {@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 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
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQuery(dynamicQuery, start, 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 {@link 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 {@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 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
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.dynamicQuery(dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static com.liferay.portal.model.UserNotificationEvent fetchUserNotificationEvent(
long userNotificationEventId)
throws com.liferay.portal.kernel.exception.SystemException {
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 null if a matching user notification event could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(
java.lang.String uuid, long companyId)
throws com.liferay.portal.kernel.exception.SystemException {
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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserNotificationEvent getUserNotificationEvent(
long userNotificationEventId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getUserNotificationEvent(userNotificationEventId);
}
public static com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getPersistedModel(primaryKeyObj);
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(
java.lang.String uuid, long companyId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.getUserNotificationEventByUuidAndCompanyId(uuid, companyId);
}
/**
* 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 {@link 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 {@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 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
* @throws SystemException if a system exception occurred
*/
public static java.util.List getUserNotificationEvents(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserNotificationEvents(start, end);
}
/**
* Returns the number of user notification events.
*
* @return the number of user notification events
* @throws SystemException if a system exception occurred
*/
public static int getUserNotificationEventsCount()
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserNotificationEventsCount();
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().updateUserNotificationEvent(userNotificationEvent);
}
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public static java.lang.String getBeanIdentifier() {
return getService().getBeanIdentifier();
}
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public static void setBeanIdentifier(java.lang.String beanIdentifier) {
getService().setBeanIdentifier(beanIdentifier);
}
public static com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
long userId,
com.liferay.portal.kernel.notifications.NotificationEvent notificationEvent)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().addUserNotificationEvent(userId, notificationEvent);
}
public static com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
long userId, java.lang.String type, long timestamp, long deliverBy,
java.lang.String payload, boolean archived,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.addUserNotificationEvent(userId, type, timestamp,
deliverBy, payload, archived, serviceContext);
}
public static java.util.List addUserNotificationEvents(
long userId,
java.util.Collection notificationEvents)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().addUserNotificationEvents(userId, notificationEvents);
}
public static void deleteUserNotificationEvent(java.lang.String uuid,
long companyId)
throws com.liferay.portal.kernel.exception.SystemException {
getService().deleteUserNotificationEvent(uuid, companyId);
}
public static void deleteUserNotificationEvents(
java.util.Collection uuids, long companyId)
throws com.liferay.portal.kernel.exception.SystemException {
getService().deleteUserNotificationEvents(uuids, companyId);
}
public static java.util.List getArchivedUserNotificationEvents(
long userId, boolean archived)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getArchivedUserNotificationEvents(userId, archived);
}
public static java.util.List getArchivedUserNotificationEvents(
long userId, boolean archived, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getArchivedUserNotificationEvents(userId, archived, start,
end);
}
public static int getArchivedUserNotificationEventsCount(long userId,
boolean archived)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getArchivedUserNotificationEventsCount(userId, archived);
}
public static java.util.List getDeliveredUserNotificationEvents(
long userId, boolean delivered)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getDeliveredUserNotificationEvents(userId, delivered);
}
public static java.util.List getDeliveredUserNotificationEvents(
long userId, boolean delivered, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getDeliveredUserNotificationEvents(userId, delivered,
start, end);
}
public static int getDeliveredUserNotificationEventsCount(long userId,
boolean delivered)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getDeliveredUserNotificationEventsCount(userId, delivered);
}
public static java.util.List getUserNotificationEvents(
long userId) throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserNotificationEvents(userId);
}
/**
* @deprecated As of 6.2.0 {@link #getArchivedUserNotificationEvents(long,
boolean)}
*/
public static java.util.List getUserNotificationEvents(
long userId, boolean archived)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserNotificationEvents(userId, archived);
}
/**
* @deprecated As of 6.2.0 {@link #getArchivedUserNotificationEvents(long,
boolean, int, int)}
*/
public static java.util.List getUserNotificationEvents(
long userId, boolean archived, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getUserNotificationEvents(userId, archived, start, end);
}
public static java.util.List getUserNotificationEvents(
long userId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserNotificationEvents(userId, start, end);
}
public static int getUserNotificationEventsCount(long userId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserNotificationEventsCount(userId);
}
/**
* @deprecated As of 6.2.0 {@link
#getArchivedUserNotificationEventsCount(long, boolean)}
*/
public static int getUserNotificationEventsCount(long userId,
boolean archived)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserNotificationEventsCount(userId, archived);
}
public static com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
java.lang.String uuid, long companyId, boolean archive)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().updateUserNotificationEvent(uuid, companyId, archive);
}
public static java.util.List updateUserNotificationEvents(
java.util.Collection uuids, long companyId,
boolean archive)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateUserNotificationEvents(uuids, companyId, archive);
}
public static UserNotificationEventLocalService getService() {
if (_service == null) {
_service = (UserNotificationEventLocalService)PortalBeanLocatorUtil.locate(UserNotificationEventLocalService.class.getName());
ReferenceRegistry.registerReference(UserNotificationEventLocalServiceUtil.class,
"_service");
}
return _service;
}
/**
* @deprecated As of 6.2.0
*/
public void setService(UserNotificationEventLocalService service) {
}
private static UserNotificationEventLocalService _service;
}