com.liferay.portal.kernel.service

Interface UserNotificationDeliveryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

UserNotificationDeliveryLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface UserNotificationDeliveryLocalService
extends BaseLocalService, PersistedModelLocalService

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 Also:

UserNotificationDeliveryLocalServiceUtil, UserNotificationDeliveryLocalServiceBaseImpl, UserNotificationDeliveryLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
UserNotificationDelivery	addUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver)
UserNotificationDelivery	addUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery) Adds the user notification delivery to the database.
UserNotificationDelivery	createUserNotificationDelivery(long userNotificationDeliveryId) Creates a new user notification delivery with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
void	deleteUserNotificationDeliveries(long userId)
UserNotificationDelivery	deleteUserNotificationDelivery(long userNotificationDeliveryId) Deletes the user notification delivery with the primary key from the database.
void	deleteUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType)
UserNotificationDelivery	deleteUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery) Deletes the user notification delivery from the database.
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
UserNotificationDelivery	fetchUserNotificationDelivery(long userNotificationDeliveryId)
UserNotificationDelivery	fetchUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<UserNotificationDelivery>	getUserNotificationDeliveries(int start, int end) Returns a range of all the user notification deliveries.
int	getUserNotificationDeliveriesCount() Returns the number of user notification deliveries.
UserNotificationDelivery	getUserNotificationDelivery(long userNotificationDeliveryId) Returns the user notification delivery with the primary key.
UserNotificationDelivery	getUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver)
UserNotificationDelivery	updateUserNotificationDelivery(long userNotificationDeliveryId, boolean deliver)
UserNotificationDelivery	updateUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery) Updates the user notification delivery in the database or adds it if it does not yet exist.

Method Detail

addUserNotificationDelivery

UserNotificationDelivery addUserNotificationDelivery(long userId,
                                                     String portletId,
                                                     long classNameId,
                                                     int notificationType,
                                                     int deliveryType,
                                                     boolean deliver)
                                              throws PortalException

Throws:

PortalException

addUserNotificationDelivery

@Indexable(type=REINDEX)
UserNotificationDelivery addUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)

Adds the user notification delivery to the database. Also notifies the appropriate model listeners.

Parameters:

userNotificationDelivery - the user notification delivery

Returns:

the user notification delivery that was added

createUserNotificationDelivery

@Transactional(enabled=false)
UserNotificationDelivery createUserNotificationDelivery(long userNotificationDeliveryId)

Creates a new user notification delivery with the primary key. Does not add the user notification delivery to the database.

Parameters:

userNotificationDeliveryId - the primary key for the new user notification delivery

Returns:

the new user notification delivery

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteUserNotificationDeliveries

void deleteUserNotificationDeliveries(long userId)

deleteUserNotificationDelivery

@Indexable(type=DELETE)
UserNotificationDelivery deleteUserNotificationDelivery(long userNotificationDeliveryId)
                                                                         throws PortalException

Deletes the user notification delivery with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

userNotificationDeliveryId - the primary key of the user notification delivery

Returns:

the user notification delivery that was removed

Throws:

PortalException - if a user notification delivery with the primary key could not be found

deleteUserNotificationDelivery

void deleteUserNotificationDelivery(long userId,
                                    String portletId,
                                    long classNameId,
                                    int notificationType,
                                    int deliveryType)

deleteUserNotificationDelivery

@Indexable(type=DELETE)
UserNotificationDelivery deleteUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)

Deletes the user notification delivery from the database. Also notifies the appropriate model listeners.

Parameters:

userNotificationDelivery - the user notification delivery

Returns:

the user notification delivery that was removed

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end)

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator<T> orderByComparator)

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchUserNotificationDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationDelivery fetchUserNotificationDelivery(long userNotificationDeliveryId)

fetchUserNotificationDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationDelivery fetchUserNotificationDelivery(long userId,
                                                                                                                          String portletId,
                                                                                                                          long classNameId,
                                                                                                                          int notificationType,
                                                                                                                          int deliveryType)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getUserNotificationDeliveries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationDelivery> getUserNotificationDeliveries(int start,
                                                                                                                                int end)

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

start - the lower bound of the range of user notification deliveries

end - the upper bound of the range of user notification deliveries (not inclusive)

Returns:

the range of user notification deliveries

getUserNotificationDeliveriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserNotificationDeliveriesCount()

Returns the number of user notification deliveries.

Returns:

the number of user notification deliveries

getUserNotificationDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationDelivery getUserNotificationDelivery(long userNotificationDeliveryId)
                                                                                                                 throws PortalException

Returns the user notification delivery with the primary key.

Parameters:

userNotificationDeliveryId - the primary key of the user notification delivery

Returns:

the user notification delivery

Throws:

PortalException - if a user notification delivery with the primary key could not be found

getUserNotificationDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationDelivery getUserNotificationDelivery(long userId,
                                                                                                                        String portletId,
                                                                                                                        long classNameId,
                                                                                                                        int notificationType,
                                                                                                                        int deliveryType,
                                                                                                                        boolean deliver)
                                                                                                                 throws PortalException

Throws:

PortalException

updateUserNotificationDelivery

UserNotificationDelivery updateUserNotificationDelivery(long userNotificationDeliveryId,
                                                        boolean deliver)

updateUserNotificationDelivery

@Indexable(type=REINDEX)
UserNotificationDelivery updateUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)

Updates the user notification delivery in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

userNotificationDelivery - the user notification delivery

Returns:

the user notification delivery that was updated