com.liferay.commerce.notification.service

Class CommerceNotificationQueueEntryLocalServiceUtil

java.lang.Object

com.liferay.commerce.notification.service.CommerceNotificationQueueEntryLocalServiceUtil

public class CommerceNotificationQueueEntryLocalServiceUtil
extends java.lang.Object

Provides the local service utility for CommerceNotificationQueueEntry. This utility wraps com.liferay.commerce.notification.service.impl.CommerceNotificationQueueEntryLocalServiceImpl 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:

CommerceNotificationQueueEntryLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
CommerceNotificationQueueEntryLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CommerceNotificationQueueEntry	addCommerceNotificationQueueEntry(CommerceNotificationQueueEntry commerceNotificationQueueEntry) Adds the commerce notification queue entry to the database.
static CommerceNotificationQueueEntry	addCommerceNotificationQueueEntry(long userId, long groupId, long commerceNotificationTemplateId, java.lang.String from, java.lang.String fromName, java.lang.String to, java.lang.String toName, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String body, double priority) Deprecated. As of Mueller (7.2.x), this method will be replaced
static CommerceNotificationQueueEntry	addCommerceNotificationQueueEntry(long userId, long groupId, java.lang.String className, long classPK, long commerceNotificationTemplateId, java.lang.String from, java.lang.String fromName, java.lang.String to, java.lang.String toName, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String body, double priority)
static CommerceNotificationQueueEntry	createCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId) Creates a new commerce notification queue entry with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static CommerceNotificationQueueEntry	deleteCommerceNotificationQueue(CommerceNotificationQueueEntry commerceNotificationQueueEntry)
static void	deleteCommerceNotificationQueueEntries(java.util.Date sentDate)
static void	deleteCommerceNotificationQueueEntries(long groupId)
static CommerceNotificationQueueEntry	deleteCommerceNotificationQueueEntry(CommerceNotificationQueueEntry commerceNotificationQueueEntry) Deletes the commerce notification queue entry from the database.
static CommerceNotificationQueueEntry	deleteCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId) Deletes the commerce notification queue entry with the primary key from the database.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
static CommerceNotificationQueueEntry	fetchCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<CommerceNotificationQueueEntry>	getCommerceNotificationQueueEntries(boolean sent)
static java.util.List<CommerceNotificationQueueEntry>	getCommerceNotificationQueueEntries(int start, int end) Returns a range of all the commerce notification queue entries.
static java.util.List<CommerceNotificationQueueEntry>	getCommerceNotificationQueueEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceNotificationQueueEntry> orderByComparator)
static java.util.List<CommerceNotificationQueueEntry>	getCommerceNotificationQueueEntries(long groupId, java.lang.String className, long classPK, boolean sent, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceNotificationQueueEntry> orderByComparator)
static int	getCommerceNotificationQueueEntriesCount() Returns the number of commerce notification queue entries.
static int	getCommerceNotificationQueueEntriesCount(long groupId)
static int	getCommerceNotificationQueueEntriesCount(long groupId, java.lang.String className, long classPK, boolean sent)
static CommerceNotificationQueueEntry	getCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId) Returns the commerce notification queue entry with the primary key.
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static CommerceNotificationQueueEntryLocalService	getService()
static CommerceNotificationQueueEntry	resendCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId)
static void	sendCommerceNotificationQueueEntries()
static void	updateCommerceNotificationQueueEntriesTemplateIds(long commerceNotificationTemplateId)
static CommerceNotificationQueueEntry	updateCommerceNotificationQueueEntry(CommerceNotificationQueueEntry commerceNotificationQueueEntry) Updates the commerce notification queue entry in the database or adds it if it does not yet exist.
static CommerceNotificationQueueEntry	updateSent(long commerceNotificationQueueEntryId, boolean sent)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommerceNotificationQueueEntryLocalServiceUtil

public CommerceNotificationQueueEntryLocalServiceUtil()

Method Detail

addCommerceNotificationQueueEntry

public static CommerceNotificationQueueEntry addCommerceNotificationQueueEntry(CommerceNotificationQueueEntry commerceNotificationQueueEntry)

Adds the commerce notification queue entry to the database. Also notifies the appropriate model listeners.

Important: Inspect CommerceNotificationQueueEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

commerceNotificationQueueEntry - the commerce notification queue entry

Returns:

the commerce notification queue entry that was added

addCommerceNotificationQueueEntry

@Deprecated
public static CommerceNotificationQueueEntry addCommerceNotificationQueueEntry(long userId,
                                                                                           long groupId,
                                                                                           long commerceNotificationTemplateId,
                                                                                           java.lang.String from,
                                                                                           java.lang.String fromName,
                                                                                           java.lang.String to,
                                                                                           java.lang.String toName,
                                                                                           java.lang.String cc,
                                                                                           java.lang.String bcc,
                                                                                           java.lang.String subject,
                                                                                           java.lang.String body,
                                                                                           double priority)
                                                                                    throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Mueller (7.2.x), this method will be replaced

Throws:

com.liferay.portal.kernel.exception.PortalException

addCommerceNotificationQueueEntry

public static CommerceNotificationQueueEntry addCommerceNotificationQueueEntry(long userId,
                                                                               long groupId,
                                                                               java.lang.String className,
                                                                               long classPK,
                                                                               long commerceNotificationTemplateId,
                                                                               java.lang.String from,
                                                                               java.lang.String fromName,
                                                                               java.lang.String to,
                                                                               java.lang.String toName,
                                                                               java.lang.String cc,
                                                                               java.lang.String bcc,
                                                                               java.lang.String subject,
                                                                               java.lang.String body,
                                                                               double priority)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceNotificationQueueEntry

public static CommerceNotificationQueueEntry createCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId)

Creates a new commerce notification queue entry with the primary key. Does not add the commerce notification queue entry to the database.

Parameters:

commerceNotificationQueueEntryId - the primary key for the new commerce notification queue entry

Returns:

the new commerce notification queue entry

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceNotificationQueue

public static CommerceNotificationQueueEntry deleteCommerceNotificationQueue(CommerceNotificationQueueEntry commerceNotificationQueueEntry)
                                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceNotificationQueueEntries

public static void deleteCommerceNotificationQueueEntries(java.util.Date sentDate)

deleteCommerceNotificationQueueEntries

public static void deleteCommerceNotificationQueueEntries(long groupId)
                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceNotificationQueueEntry

public static CommerceNotificationQueueEntry deleteCommerceNotificationQueueEntry(CommerceNotificationQueueEntry commerceNotificationQueueEntry)

Deletes the commerce notification queue entry from the database. Also notifies the appropriate model listeners.

Important: Inspect CommerceNotificationQueueEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

commerceNotificationQueueEntry - the commerce notification queue entry

Returns:

the commerce notification queue entry that was removed

deleteCommerceNotificationQueueEntry

public static CommerceNotificationQueueEntry deleteCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Deletes the commerce notification queue entry with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect CommerceNotificationQueueEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

commerceNotificationQueueEntryId - the primary key of the commerce notification queue entry

Returns:

the commerce notification queue entry that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a commerce notification queue entry with the primary key could not be found

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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.commerce.notification.model.impl.CommerceNotificationQueueEntryModelImpl.

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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.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.commerce.notification.model.impl.CommerceNotificationQueueEntryModelImpl.

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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.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

fetchCommerceNotificationQueueEntry

public static CommerceNotificationQueueEntry fetchCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId)

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCommerceNotificationQueueEntries

public static java.util.List<CommerceNotificationQueueEntry> getCommerceNotificationQueueEntries(boolean sent)

getCommerceNotificationQueueEntries

public static java.util.List<CommerceNotificationQueueEntry> getCommerceNotificationQueueEntries(int start,
                                                                                                 int end)

Returns a range of all the commerce notification queue entries.

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.commerce.notification.model.impl.CommerceNotificationQueueEntryModelImpl.

Parameters:

start - the lower bound of the range of commerce notification queue entries

end - the upper bound of the range of commerce notification queue entries (not inclusive)

Returns:

the range of commerce notification queue entries

getCommerceNotificationQueueEntries

public static java.util.List<CommerceNotificationQueueEntry> getCommerceNotificationQueueEntries(long groupId,
                                                                                                 int start,
                                                                                                 int end,
                                                                                                 com.liferay.portal.kernel.util.OrderByComparator<CommerceNotificationQueueEntry> orderByComparator)

getCommerceNotificationQueueEntries

public static java.util.List<CommerceNotificationQueueEntry> getCommerceNotificationQueueEntries(long groupId,
                                                                                                 java.lang.String className,
                                                                                                 long classPK,
                                                                                                 boolean sent,
                                                                                                 int start,
                                                                                                 int end,
                                                                                                 com.liferay.portal.kernel.util.OrderByComparator<CommerceNotificationQueueEntry> orderByComparator)

getCommerceNotificationQueueEntriesCount

public static int getCommerceNotificationQueueEntriesCount()

Returns the number of commerce notification queue entries.

Returns:

the number of commerce notification queue entries

getCommerceNotificationQueueEntriesCount

public static int getCommerceNotificationQueueEntriesCount(long groupId)

getCommerceNotificationQueueEntriesCount

public static int getCommerceNotificationQueueEntriesCount(long groupId,
                                                           java.lang.String className,
                                                           long classPK,
                                                           boolean sent)

getCommerceNotificationQueueEntry

public static CommerceNotificationQueueEntry getCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce notification queue entry with the primary key.

Parameters:

commerceNotificationQueueEntryId - the primary key of the commerce notification queue entry

Returns:

the commerce notification queue entry

Throws:

com.liferay.portal.kernel.exception.PortalException - if a commerce notification queue entry with the primary key could not be found

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

resendCommerceNotificationQueueEntry

public static CommerceNotificationQueueEntry resendCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

sendCommerceNotificationQueueEntries

public static void sendCommerceNotificationQueueEntries()
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

updateCommerceNotificationQueueEntriesTemplateIds

public static void updateCommerceNotificationQueueEntriesTemplateIds(long commerceNotificationTemplateId)

updateCommerceNotificationQueueEntry

public static CommerceNotificationQueueEntry updateCommerceNotificationQueueEntry(CommerceNotificationQueueEntry commerceNotificationQueueEntry)

Updates the commerce notification queue entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect CommerceNotificationQueueEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

commerceNotificationQueueEntry - the commerce notification queue entry

Returns:

the commerce notification queue entry that was updated

updateSent

public static CommerceNotificationQueueEntry updateSent(long commerceNotificationQueueEntryId,
                                                        boolean sent)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CommerceNotificationQueueEntryLocalService getService()