com.liferay.portal.service.persistence.UserNotificationDeliveryPersistence 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.persistence;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.model.UserNotificationDelivery;
/**
* The persistence interface for the user notification delivery service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see UserNotificationDeliveryPersistenceImpl
* @see UserNotificationDeliveryUtil
* @generated
*/
@ProviderType
public interface UserNotificationDeliveryPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link UserNotificationDeliveryUtil} to access the user notification delivery persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns all the user notification deliveries where userId = ?.
*
* @param userId the user ID
* @return the matching user notification deliveries
* @throws SystemException if a system exception occurred
*/
public java.util.List findByUserId(
long userId) throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the user notification deliveries where userId = ?.
*
*
* 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.UserNotificationDeliveryModelImpl}. 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 userId the user ID
* @param start the lower bound of the range of user notification deliveries
* @param end the upper bound of the range of user notification deliveries (not inclusive)
* @return the range of matching user notification deliveries
* @throws SystemException if a system exception occurred
*/
public java.util.List findByUserId(
long userId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the user notification deliveries where userId = ?.
*
*
* 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.UserNotificationDeliveryModelImpl}. 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 userId the user ID
* @param start the lower bound of the range of user notification deliveries
* @param end the upper bound of the range of user notification deliveries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching user notification deliveries
* @throws SystemException if a system exception occurred
*/
public java.util.List findByUserId(
long userId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first user notification delivery in the ordered set where userId = ?.
*
* @param userId the user ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching user notification delivery
* @throws com.liferay.portal.NoSuchUserNotificationDeliveryException if a matching user notification delivery could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery findByUserId_First(
long userId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchUserNotificationDeliveryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first user notification delivery in the ordered set where userId = ?.
*
* @param userId the user ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching user notification delivery, or null if a matching user notification delivery could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery fetchByUserId_First(
long userId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last user notification delivery in the ordered set where userId = ?.
*
* @param userId the user ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching user notification delivery
* @throws com.liferay.portal.NoSuchUserNotificationDeliveryException if a matching user notification delivery could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery findByUserId_Last(
long userId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchUserNotificationDeliveryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last user notification delivery in the ordered set where userId = ?.
*
* @param userId the user ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching user notification delivery, or null if a matching user notification delivery could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery fetchByUserId_Last(
long userId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the user notification deliveries before and after the current user notification delivery in the ordered set where userId = ?.
*
* @param userNotificationDeliveryId the primary key of the current user notification delivery
* @param userId the user ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next user notification delivery
* @throws com.liferay.portal.NoSuchUserNotificationDeliveryException if a user notification delivery with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery[] findByUserId_PrevAndNext(
long userNotificationDeliveryId, long userId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchUserNotificationDeliveryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the user notification deliveries where userId = ? from the database.
*
* @param userId the user ID
* @throws SystemException if a system exception occurred
*/
public void removeByUserId(long userId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of user notification deliveries where userId = ?.
*
* @param userId the user ID
* @return the number of matching user notification deliveries
* @throws SystemException if a system exception occurred
*/
public int countByUserId(long userId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the user notification delivery where userId = ? and portletId = ? and classNameId = ? and notificationType = ? and deliveryType = ? or throws a {@link com.liferay.portal.NoSuchUserNotificationDeliveryException} if it could not be found.
*
* @param userId the user ID
* @param portletId the portlet ID
* @param classNameId the class name ID
* @param notificationType the notification type
* @param deliveryType the delivery type
* @return the matching user notification delivery
* @throws com.liferay.portal.NoSuchUserNotificationDeliveryException if a matching user notification delivery could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery findByU_P_C_N_D(
long userId, java.lang.String portletId, long classNameId,
int notificationType, int deliveryType)
throws com.liferay.portal.NoSuchUserNotificationDeliveryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the user notification delivery where userId = ? and portletId = ? and classNameId = ? and notificationType = ? and deliveryType = ? or returns null if it could not be found. Uses the finder cache.
*
* @param userId the user ID
* @param portletId the portlet ID
* @param classNameId the class name ID
* @param notificationType the notification type
* @param deliveryType the delivery type
* @return the matching user notification delivery, or null if a matching user notification delivery could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery fetchByU_P_C_N_D(
long userId, java.lang.String portletId, long classNameId,
int notificationType, int deliveryType)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the user notification delivery where userId = ? and portletId = ? and classNameId = ? and notificationType = ? and deliveryType = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param userId the user ID
* @param portletId the portlet ID
* @param classNameId the class name ID
* @param notificationType the notification type
* @param deliveryType the delivery type
* @param retrieveFromCache whether to use the finder cache
* @return the matching user notification delivery, or null if a matching user notification delivery could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery fetchByU_P_C_N_D(
long userId, java.lang.String portletId, long classNameId,
int notificationType, int deliveryType, boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the user notification delivery where userId = ? and portletId = ? and classNameId = ? and notificationType = ? and deliveryType = ? from the database.
*
* @param userId the user ID
* @param portletId the portlet ID
* @param classNameId the class name ID
* @param notificationType the notification type
* @param deliveryType the delivery type
* @return the user notification delivery that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery removeByU_P_C_N_D(
long userId, java.lang.String portletId, long classNameId,
int notificationType, int deliveryType)
throws com.liferay.portal.NoSuchUserNotificationDeliveryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of user notification deliveries where userId = ? and portletId = ? and classNameId = ? and notificationType = ? and deliveryType = ?.
*
* @param userId the user ID
* @param portletId the portlet ID
* @param classNameId the class name ID
* @param notificationType the notification type
* @param deliveryType the delivery type
* @return the number of matching user notification deliveries
* @throws SystemException if a system exception occurred
*/
public int countByU_P_C_N_D(long userId, java.lang.String portletId,
long classNameId, int notificationType, int deliveryType)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Caches the user notification delivery in the entity cache if it is enabled.
*
* @param userNotificationDelivery the user notification delivery
*/
public void cacheResult(
com.liferay.portal.model.UserNotificationDelivery userNotificationDelivery);
/**
* Caches the user notification deliveries in the entity cache if it is enabled.
*
* @param userNotificationDeliveries the user notification deliveries
*/
public void cacheResult(
java.util.List userNotificationDeliveries);
/**
* Creates a new user notification delivery with the primary key. Does not add the user notification delivery to the database.
*
* @param userNotificationDeliveryId the primary key for the new user notification delivery
* @return the new user notification delivery
*/
public com.liferay.portal.model.UserNotificationDelivery create(
long userNotificationDeliveryId);
/**
* Removes the user notification delivery with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param userNotificationDeliveryId the primary key of the user notification delivery
* @return the user notification delivery that was removed
* @throws com.liferay.portal.NoSuchUserNotificationDeliveryException if a user notification delivery with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery remove(
long userNotificationDeliveryId)
throws com.liferay.portal.NoSuchUserNotificationDeliveryException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.UserNotificationDelivery updateImpl(
com.liferay.portal.model.UserNotificationDelivery userNotificationDelivery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the user notification delivery with the primary key or throws a {@link com.liferay.portal.NoSuchUserNotificationDeliveryException} if it could not be found.
*
* @param userNotificationDeliveryId the primary key of the user notification delivery
* @return the user notification delivery
* @throws com.liferay.portal.NoSuchUserNotificationDeliveryException if a user notification delivery with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery findByPrimaryKey(
long userNotificationDeliveryId)
throws com.liferay.portal.NoSuchUserNotificationDeliveryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the user notification delivery with the primary key or returns null if it could not be found.
*
* @param userNotificationDeliveryId the primary key of the user notification delivery
* @return the user notification delivery, or null if a user notification delivery with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserNotificationDelivery fetchByPrimaryKey(
long userNotificationDeliveryId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the user notification deliveries.
*
* @return the user notification deliveries
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the user notification deliveries.
*
*
* 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.UserNotificationDeliveryModelImpl}. 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 deliveries
* @param end the upper bound of the range of user notification deliveries (not inclusive)
* @return the range of user notification deliveries
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the user notification deliveries.
*
*
* 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.UserNotificationDeliveryModelImpl}. 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 deliveries
* @param end the upper bound of the range of user notification deliveries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of user notification deliveries
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the user notification deliveries from the database.
*
* @throws SystemException if a system exception occurred
*/
public void removeAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of user notification deliveries.
*
* @return the number of user notification deliveries
* @throws SystemException if a system exception occurred
*/
public int countAll()
throws com.liferay.portal.kernel.exception.SystemException;
}