com.liferay.push.notifications.service

Class PushNotificationsDeviceLocalServiceUtil

java.lang.Object

com.liferay.push.notifications.service.PushNotificationsDeviceLocalServiceUtil

public class PushNotificationsDeviceLocalServiceUtil
extends java.lang.Object

Provides the local service utility for PushNotificationsDevice. This utility wraps com.liferay.push.notifications.service.impl.PushNotificationsDeviceLocalServiceImpl and is an 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:

PushNotificationsDeviceLocalService

Constructor Summary

Constructors

Constructor and Description
PushNotificationsDeviceLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static PushNotificationsDevice	addPushNotificationsDevice(long userId, java.lang.String platform, java.lang.String token)
static PushNotificationsDevice	addPushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice) Adds the push notifications device to the database.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static PushNotificationsDevice	createPushNotificationsDevice(long pushNotificationsDeviceId) Creates a new push notifications device with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static PushNotificationsDevice	deletePushNotificationsDevice(long pushNotificationsDeviceId) Deletes the push notifications device with the primary key from the database.
static PushNotificationsDevice	deletePushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice) Deletes the push notifications device from the database.
static PushNotificationsDevice	deletePushNotificationsDevice(java.lang.String token)
static <T> T	dslQuery(DSLQuery dslQuery)
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 PushNotificationsDevice	fetchPushNotificationsDevice(long pushNotificationsDeviceId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static PushNotificationsDevice	getPushNotificationsDevice(long pushNotificationsDeviceId) Returns the push notifications device with the primary key.
static java.util.List<PushNotificationsDevice>	getPushNotificationsDevices(int start, int end) Returns a range of all the push notifications devices.
static java.util.List<PushNotificationsDevice>	getPushNotificationsDevices(int start, int end, OrderByComparator<PushNotificationsDevice> orderByComparator)
static int	getPushNotificationsDevicesCount() Returns the number of push notifications devices.
static PushNotificationsDeviceLocalService	getService()
static void	sendPushNotification(long[] toUserIds, JSONObject payloadJSONObject)
static void	sendPushNotification(java.lang.String platform, java.util.List<java.lang.String> tokens, JSONObject payloadJSONObject)
static PushNotificationsDevice	updatePushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice) Updates the push notifications device in the database or adds it if it does not yet exist.
static void	updateToken(java.lang.String oldToken, java.lang.String newToken)

Methods inherited from class java.lang.Object

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

Constructor Detail

PushNotificationsDeviceLocalServiceUtil

public PushNotificationsDeviceLocalServiceUtil()

Method Detail

addPushNotificationsDevice

public static PushNotificationsDevice addPushNotificationsDevice(long userId,
                                                                 java.lang.String platform,
                                                                 java.lang.String token)
                                                          throws PortalException

Throws:

PortalException

addPushNotificationsDevice

public static PushNotificationsDevice addPushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice)

Adds the push notifications device to the database. Also notifies the appropriate model listeners.

Parameters:

pushNotificationsDevice - the push notifications device

Returns:

the push notifications device that was added

createPersistedModel

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

Throws:

PortalException

createPushNotificationsDevice

public static PushNotificationsDevice createPushNotificationsDevice(long pushNotificationsDeviceId)

Creates a new push notifications device with the primary key. Does not add the push notifications device to the database.

Parameters:

pushNotificationsDeviceId - the primary key for the new push notifications device

Returns:

the new push notifications device

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deletePushNotificationsDevice

public static PushNotificationsDevice deletePushNotificationsDevice(long pushNotificationsDeviceId)
                                                             throws PortalException

Deletes the push notifications device with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

pushNotificationsDeviceId - the primary key of the push notifications device

Returns:

the push notifications device that was removed

Throws:

PortalException - if a push notifications device with the primary key could not be found

deletePushNotificationsDevice

public static PushNotificationsDevice deletePushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice)

Deletes the push notifications device from the database. Also notifies the appropriate model listeners.

Parameters:

pushNotificationsDevice - the push notifications device

Returns:

the push notifications device that was removed

deletePushNotificationsDevice

public static PushNotificationsDevice deletePushNotificationsDevice(java.lang.String token)
                                                             throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

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 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, then the query will include the default ORDER BY logic from com.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl.

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 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, then the query will include the default ORDER BY logic from com.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl.

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

fetchPushNotificationsDevice

public static PushNotificationsDevice fetchPushNotificationsDevice(long pushNotificationsDeviceId)

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

getPushNotificationsDevice

public static PushNotificationsDevice getPushNotificationsDevice(long pushNotificationsDeviceId)
                                                          throws PortalException

Returns the push notifications device with the primary key.

Parameters:

pushNotificationsDeviceId - the primary key of the push notifications device

Returns:

the push notifications device

Throws:

PortalException - if a push notifications device with the primary key could not be found

getPushNotificationsDevices

public static java.util.List<PushNotificationsDevice> getPushNotificationsDevices(int start,
                                                                                  int end)

Returns a range of all the push notifications devices.

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 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, then the query will include the default ORDER BY logic from com.liferay.push.notifications.model.impl.PushNotificationsDeviceModelImpl.

Parameters:

start - the lower bound of the range of push notifications devices

end - the upper bound of the range of push notifications devices (not inclusive)

Returns:

the range of push notifications devices

getPushNotificationsDevices

public static java.util.List<PushNotificationsDevice> getPushNotificationsDevices(int start,
                                                                                  int end,
                                                                                  OrderByComparator<PushNotificationsDevice> orderByComparator)

getPushNotificationsDevicesCount

public static int getPushNotificationsDevicesCount()

Returns the number of push notifications devices.

Returns:

the number of push notifications devices

sendPushNotification

public static void sendPushNotification(long[] toUserIds,
                                        JSONObject payloadJSONObject)
                                 throws PortalException

Throws:

PortalException

sendPushNotification

public static void sendPushNotification(java.lang.String platform,
                                        java.util.List<java.lang.String> tokens,
                                        JSONObject payloadJSONObject)
                                 throws PortalException

Throws:

PortalException

updatePushNotificationsDevice

public static PushNotificationsDevice updatePushNotificationsDevice(PushNotificationsDevice pushNotificationsDevice)

Updates the push notifications device in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

pushNotificationsDevice - the push notifications device

Returns:

the push notifications device that was updated

updateToken

public static void updateToken(java.lang.String oldToken,
                               java.lang.String newToken)
                        throws PortalException

Throws:

PortalException

getService

public static PushNotificationsDeviceLocalService getService()