com.liferay.portal.kernel.service.UserNotificationDeliveryLocalService Maven / Gradle / Ivy
Show all versions of com.liferay.portal.kernel Show documentation
/**
* 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.model.PersistedModel;
import com.liferay.portal.kernel.model.UserNotificationDelivery;
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.List;
/**
* Provides the local service interface for UserNotificationDelivery. 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 UserNotificationDeliveryLocalServiceUtil
* @see com.liferay.portal.service.base.UserNotificationDeliveryLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.UserNotificationDeliveryLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface UserNotificationDeliveryLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link UserNotificationDeliveryLocalServiceUtil} to access the user notification delivery local service. Add custom service methods to {@link com.liferay.portal.service.impl.UserNotificationDeliveryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
public UserNotificationDelivery addUserNotificationDelivery(long userId,
java.lang.String portletId, long classNameId, int notificationType,
int deliveryType, boolean deliver) throws PortalException;
/**
* Adds the user notification delivery to the database. Also notifies the appropriate model listeners.
*
* @param userNotificationDelivery the user notification delivery
* @return the user notification delivery that was added
*/
@Indexable(type = IndexableType.REINDEX)
public UserNotificationDelivery addUserNotificationDelivery(
UserNotificationDelivery userNotificationDelivery);
/**
* 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 UserNotificationDelivery createUserNotificationDelivery(
long userNotificationDeliveryId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
public void deleteUserNotificationDeliveries(long userId);
public void deleteUserNotificationDelivery(long userId,
java.lang.String portletId, long classNameId, int notificationType,
int deliveryType);
/**
* Deletes the user notification delivery from the database. Also notifies the appropriate model listeners.
*
* @param userNotificationDelivery the user notification delivery
* @return the user notification delivery that was removed
*/
@Indexable(type = IndexableType.DELETE)
public UserNotificationDelivery deleteUserNotificationDelivery(
UserNotificationDelivery userNotificationDelivery);
/**
* Deletes 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 PortalException if a user notification delivery with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public UserNotificationDelivery deleteUserNotificationDelivery(
long userNotificationDeliveryId) throws PortalException;
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
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 {@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 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 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 {@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 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
*/
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
*/
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
*/
public long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public UserNotificationDelivery fetchUserNotificationDelivery(long userId,
java.lang.String portletId, long classNameId, int notificationType,
int deliveryType);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public UserNotificationDelivery fetchUserNotificationDelivery(
long userNotificationDeliveryId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public java.lang.String getOSGiServiceIdentifier();
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserNotificationDeliveries(
int start, int end);
/**
* Returns the number of user notification deliveries.
*
* @return the number of user notification deliveries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserNotificationDeliveriesCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public UserNotificationDelivery getUserNotificationDelivery(long userId,
java.lang.String portletId, long classNameId, int notificationType,
int deliveryType, boolean deliver) throws PortalException;
/**
* Returns the user notification delivery with the primary key.
*
* @param userNotificationDeliveryId the primary key of the user notification delivery
* @return the user notification delivery
* @throws PortalException if a user notification delivery with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public UserNotificationDelivery getUserNotificationDelivery(
long userNotificationDeliveryId) throws PortalException;
/**
* Updates the user notification delivery in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param userNotificationDelivery the user notification delivery
* @return the user notification delivery that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public UserNotificationDelivery updateUserNotificationDelivery(
UserNotificationDelivery userNotificationDelivery);
public UserNotificationDelivery updateUserNotificationDelivery(
long userNotificationDeliveryId, boolean deliver);
}