com.liferay.portal.kernel.service

Class UserNotificationDeliveryLocalServiceUtil

java.lang.Object

com.liferay.portal.kernel.service.UserNotificationDeliveryLocalServiceUtil

@ProviderType
public class UserNotificationDeliveryLocalServiceUtil
extends java.lang.Object

Provides the local service utility for UserNotificationDelivery. This utility wraps UserNotificationDeliveryLocalServiceImpl 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 Also:

UserNotificationDeliveryLocalService, UserNotificationDeliveryLocalServiceBaseImpl, UserNotificationDeliveryLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
UserNotificationDeliveryLocalServiceUtil()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserNotificationDeliveryLocalServiceUtil

public UserNotificationDeliveryLocalServiceUtil()

Method Detail

addUserNotificationDelivery

public static UserNotificationDelivery addUserNotificationDelivery(long userId,
                                                                   java.lang.String portletId,
                                                                   long classNameId,
                                                                   int notificationType,
                                                                   int deliveryType,
                                                                   boolean deliver)
                                                            throws PortalException

Throws:

PortalException

addUserNotificationDelivery

public static 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

public static 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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteUserNotificationDeliveries

public static void deleteUserNotificationDeliveries(long userId)

deleteUserNotificationDelivery

public static 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

public static void deleteUserNotificationDelivery(long userId,
                                                  java.lang.String portletId,
                                                  long classNameId,
                                                  int notificationType,
                                                  int deliveryType)

deleteUserNotificationDelivery

public static 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

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.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

public static <T> java.util.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

public static <T> java.util.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

public static 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

public static 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

public static UserNotificationDelivery fetchUserNotificationDelivery(long userNotificationDeliveryId)

fetchUserNotificationDelivery

public static UserNotificationDelivery fetchUserNotificationDelivery(long userId,
                                                                     java.lang.String portletId,
                                                                     long classNameId,
                                                                     int notificationType,
                                                                     int deliveryType)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getUserNotificationDeliveries

public static java.util.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

public static int getUserNotificationDeliveriesCount()

Returns the number of user notification deliveries.

Returns:

the number of user notification deliveries

getUserNotificationDelivery

public static 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

public static UserNotificationDelivery getUserNotificationDelivery(long userId,
                                                                   java.lang.String portletId,
                                                                   long classNameId,
                                                                   int notificationType,
                                                                   int deliveryType,
                                                                   boolean deliver)
                                                            throws PortalException

Throws:

PortalException

updateUserNotificationDelivery

public static UserNotificationDelivery updateUserNotificationDelivery(long userNotificationDeliveryId,
                                                                      boolean deliver)

updateUserNotificationDelivery

public static 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

getService

public static UserNotificationDeliveryLocalService getService()