com.liferay.portal.service
Class UserNotificationEventLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.UserNotificationEventLocalServiceUtil

@ProviderType
public class UserNotificationEventLocalServiceUtil
extends Object

Provides the local service utility for UserNotificationEvent. This utility wraps 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.

See Also:

UserNotificationEventLocalService, UserNotificationEventLocalServiceBaseImpl, com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl

Constructor Summary

UserNotificationEventLocalServiceUtil()

Method Summary

static UserNotificationEvent	addUserNotificationEvent(long userId, NotificationEvent notificationEvent)
static UserNotificationEvent	addUserNotificationEvent(long userId, String type, long timestamp, long deliverBy, String payload, boolean archived, ServiceContext serviceContext)
static UserNotificationEvent	addUserNotificationEvent(UserNotificationEvent userNotificationEvent) Adds the user notification event to the database.
static List<UserNotificationEvent>	addUserNotificationEvents(long userId, Collection<NotificationEvent> notificationEvents)
static UserNotificationEvent	createUserNotificationEvent(long userNotificationEventId) Creates a new user notification event with the primary key.
static UserNotificationEvent	deleteUserNotificationEvent(long userNotificationEventId) Deletes the user notification event with the primary key from the database.
static void	deleteUserNotificationEvent(String uuid, long companyId)
static UserNotificationEvent	deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent) Deletes the user notification event from the database.
static void	deleteUserNotificationEvents(Collection<String> uuids, long companyId)
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static UserNotificationEvent	fetchUserNotificationEvent(long userNotificationEventId)
static UserNotificationEvent	fetchUserNotificationEventByUuidAndCompanyId(String uuid, long companyId) Returns the user notification event with the matching UUID and company.
static List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, boolean archived)
static List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, boolean archived, int start, int end)
static int	getArchivedUserNotificationEventsCount(long userId, boolean archived)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, boolean delivered)
static List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, boolean delivered, int start, int end)
static int	getDeliveredUserNotificationEventsCount(long userId, boolean delivered)
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static UserNotificationEventLocalService	getService()
static UserNotificationEvent	getUserNotificationEvent(long userNotificationEventId) Returns the user notification event with the primary key.
static UserNotificationEvent	getUserNotificationEventByUuidAndCompanyId(String uuid, long companyId) Returns the user notification event with the matching UUID and company.
static List<UserNotificationEvent>	getUserNotificationEvents(int start, int end) Returns a range of all the user notification events.
static List<UserNotificationEvent>	getUserNotificationEvents(long userId)
static List<UserNotificationEvent>	getUserNotificationEvents(long userId, boolean archived) Deprecated. As of 6.2.0 getArchivedUserNotificationEvents(long, boolean)
static List<UserNotificationEvent>	getUserNotificationEvents(long userId, boolean archived, int start, int end) Deprecated. As of 6.2.0 getArchivedUserNotificationEvents(long, boolean, int, int)
static List<UserNotificationEvent>	getUserNotificationEvents(long userId, int start, int end)
static int	getUserNotificationEventsCount() Returns the number of user notification events.
static int	getUserNotificationEventsCount(long userId)
static int	getUserNotificationEventsCount(long userId, boolean archived) Deprecated. As of 6.2.0 getArchivedUserNotificationEventsCount(long, boolean)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(UserNotificationEventLocalService service) Deprecated. As of 6.2.0
static UserNotificationEvent	updateUserNotificationEvent(String uuid, long companyId, boolean archive)
static UserNotificationEvent	updateUserNotificationEvent(UserNotificationEvent userNotificationEvent) Updates the user notification event in the database or adds it if it does not yet exist.
static List<UserNotificationEvent>	updateUserNotificationEvents(Collection<String> uuids, long companyId, boolean archive)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserNotificationEventLocalServiceUtil

public UserNotificationEventLocalServiceUtil()

Method Detail

addUserNotificationEvent

public static UserNotificationEvent addUserNotificationEvent(UserNotificationEvent userNotificationEvent)
                                                      throws SystemException

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

Parameters:

userNotificationEvent - the user notification event

Returns:

the user notification event that was added

Throws:

SystemException - if a system exception occurred

createUserNotificationEvent

public static UserNotificationEvent createUserNotificationEvent(long userNotificationEventId)

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

Parameters:

userNotificationEventId - the primary key for the new user notification event

Returns:

the new user notification event

deleteUserNotificationEvent

public static UserNotificationEvent deleteUserNotificationEvent(long userNotificationEventId)
                                                         throws PortalException,
                                                                SystemException

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

Parameters:

userNotificationEventId - the primary key of the user notification event

Returns:

the user notification event that was removed

Throws:

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

SystemException - if a system exception occurred

deleteUserNotificationEvent

public static UserNotificationEvent deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent)
                                                         throws SystemException

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

Parameters:

userNotificationEvent - the user notification event

Returns:

the user notification event that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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 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.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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 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.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchUserNotificationEvent

public static UserNotificationEvent fetchUserNotificationEvent(long userNotificationEventId)
                                                        throws SystemException

Throws:

SystemException

fetchUserNotificationEventByUuidAndCompanyId

public static UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(String uuid,
                                                                                 long companyId)
                                                                          throws SystemException

Returns the user notification event with the matching UUID and company.

Parameters:

uuid - the user notification event's UUID

companyId - the primary key of the company

Returns:

the matching user notification event, or null if a matching user notification event could not be found

Throws:

SystemException - if a system exception occurred

getUserNotificationEvent

public static UserNotificationEvent getUserNotificationEvent(long userNotificationEventId)
                                                      throws PortalException,
                                                             SystemException

Returns the user notification event with the primary key.

Parameters:

userNotificationEventId - the primary key of the user notification event

Returns:

the user notification event

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getUserNotificationEventByUuidAndCompanyId

public static UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(String uuid,
                                                                               long companyId)
                                                                        throws PortalException,
                                                                               SystemException

Returns the user notification event with the matching UUID and company.

Parameters:

uuid - the user notification event's UUID

companyId - the primary key of the company

Returns:

the matching user notification event

Throws:

PortalException - if a matching user notification event could not be found

SystemException - if a system exception occurred

getUserNotificationEvents

public static List<UserNotificationEvent> getUserNotificationEvents(int start,
                                                                    int end)
                                                             throws SystemException

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 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 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.

Parameters:

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

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

Returns:

the range of user notification events

Throws:

SystemException - if a system exception occurred

getUserNotificationEventsCount

public static int getUserNotificationEventsCount()
                                          throws SystemException

Returns the number of user notification events.

Returns:

the number of user notification events

Throws:

SystemException - if a system exception occurred

updateUserNotificationEvent

public static UserNotificationEvent updateUserNotificationEvent(UserNotificationEvent userNotificationEvent)
                                                         throws SystemException

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

Parameters:

userNotificationEvent - the user notification event

Returns:

the user notification event that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addUserNotificationEvent

public static UserNotificationEvent addUserNotificationEvent(long userId,
                                                             NotificationEvent notificationEvent)
                                                      throws PortalException,
                                                             SystemException

Throws:

PortalException

SystemException

addUserNotificationEvent

public static UserNotificationEvent addUserNotificationEvent(long userId,
                                                             String type,
                                                             long timestamp,
                                                             long deliverBy,
                                                             String payload,
                                                             boolean archived,
                                                             ServiceContext serviceContext)
                                                      throws PortalException,
                                                             SystemException

Throws:

PortalException

SystemException

addUserNotificationEvents

public static List<UserNotificationEvent> addUserNotificationEvents(long userId,
                                                                    Collection<NotificationEvent> notificationEvents)
                                                             throws PortalException,
                                                                    SystemException

Throws:

PortalException

SystemException

deleteUserNotificationEvent

public static void deleteUserNotificationEvent(String uuid,
                                               long companyId)
                                        throws SystemException

Throws:

SystemException

deleteUserNotificationEvents

public static void deleteUserNotificationEvents(Collection<String> uuids,
                                                long companyId)
                                         throws SystemException

Throws:

SystemException

getArchivedUserNotificationEvents

public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                            boolean archived)
                                                                     throws SystemException

Throws:

SystemException

getArchivedUserNotificationEvents

public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                            boolean archived,
                                                                            int start,
                                                                            int end)
                                                                     throws SystemException

Throws:

SystemException

getArchivedUserNotificationEventsCount

public static int getArchivedUserNotificationEventsCount(long userId,
                                                         boolean archived)
                                                  throws SystemException

Throws:

SystemException

getDeliveredUserNotificationEvents

public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                             boolean delivered)
                                                                      throws SystemException

Throws:

SystemException

getDeliveredUserNotificationEvents

public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                             boolean delivered,
                                                                             int start,
                                                                             int end)
                                                                      throws SystemException

Throws:

SystemException

getDeliveredUserNotificationEventsCount

public static int getDeliveredUserNotificationEventsCount(long userId,
                                                          boolean delivered)
                                                   throws SystemException

Throws:

SystemException

getUserNotificationEvents

public static List<UserNotificationEvent> getUserNotificationEvents(long userId)
                                                             throws SystemException

Throws:

SystemException

getUserNotificationEvents

public static List<UserNotificationEvent> getUserNotificationEvents(long userId,
                                                                    boolean archived)
                                                             throws SystemException

Deprecated. As of 6.2.0 getArchivedUserNotificationEvents(long, boolean)

Throws:

SystemException

getUserNotificationEvents

public static List<UserNotificationEvent> getUserNotificationEvents(long userId,
                                                                    boolean archived,
                                                                    int start,
                                                                    int end)
                                                             throws SystemException

Deprecated. As of 6.2.0 getArchivedUserNotificationEvents(long, boolean, int, int)

Throws:

SystemException

getUserNotificationEvents

public static List<UserNotificationEvent> getUserNotificationEvents(long userId,
                                                                    int start,
                                                                    int end)
                                                             throws SystemException

Throws:

SystemException

getUserNotificationEventsCount

public static int getUserNotificationEventsCount(long userId)
                                          throws SystemException

Throws:

SystemException

getUserNotificationEventsCount

public static int getUserNotificationEventsCount(long userId,
                                                 boolean archived)
                                          throws SystemException

Deprecated. As of 6.2.0 getArchivedUserNotificationEventsCount(long, boolean)

Throws:

SystemException

updateUserNotificationEvent

public static UserNotificationEvent updateUserNotificationEvent(String uuid,
                                                                long companyId,
                                                                boolean archive)
                                                         throws SystemException

Throws:

SystemException

updateUserNotificationEvents

public static List<UserNotificationEvent> updateUserNotificationEvents(Collection<String> uuids,
                                                                       long companyId,
                                                                       boolean archive)
                                                                throws SystemException

Throws:

SystemException

getService

public static UserNotificationEventLocalService getService()

setService

public void setService(UserNotificationEventLocalService service)

Deprecated. As of 6.2.0