com.liferay.commerce.notification.service

Interface CommerceNotificationQueueEntryLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

CommerceNotificationQueueEntryLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface CommerceNotificationQueueEntryLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for CommerceNotificationQueueEntry. 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:

CommerceNotificationQueueEntryLocalServiceUtil

Generated:

Method Summary

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

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addCommerceNotificationQueueEntry

@Indexable(type=REINDEX)
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
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

@Indexable(type=REINDEX)
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

@Transactional(enabled=false)
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

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

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceNotificationQueue

@Indexable(type=DELETE)
 @SystemEvent(type=1)
CommerceNotificationQueueEntry deleteCommerceNotificationQueue(CommerceNotificationQueueEntry commerceNotificationQueueEntry)
                                                                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceNotificationQueueEntries

void deleteCommerceNotificationQueueEntries(java.util.Date sentDate)

deleteCommerceNotificationQueueEntries

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceNotificationQueueEntry

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

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

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceNotificationQueueEntry fetchCommerceNotificationQueueEntry(long commerceNotificationQueueEntryId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCommerceNotificationQueueEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceNotificationQueueEntry> getCommerceNotificationQueueEntries(boolean sent)

getCommerceNotificationQueueEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceNotificationQueueEntry> getCommerceNotificationQueueEntries(long groupId,
                                                                                                                                                      int start,
                                                                                                                                                      int end,
                                                                                                                                                      com.liferay.portal.kernel.util.OrderByComparator<CommerceNotificationQueueEntry> orderByComparator)

getCommerceNotificationQueueEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

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

Returns the number of commerce notification queue entries.

Returns:

the number of commerce notification queue entries

getCommerceNotificationQueueEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceNotificationQueueEntriesCount(long groupId)

getCommerceNotificationQueueEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceNotificationQueueEntriesCount(long groupId,
                                                                                                                java.lang.String className,
                                                                                                                long classPK,
                                                                                                                boolean sent)

getCommerceNotificationQueueEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

resendCommerceNotificationQueueEntry

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

Throws:

com.liferay.portal.kernel.exception.PortalException

sendCommerceNotificationQueueEntries

void sendCommerceNotificationQueueEntries()
                                   throws java.lang.Exception

Throws:

java.lang.Exception

updateCommerceNotificationQueueEntriesTemplateIds

void updateCommerceNotificationQueueEntriesTemplateIds(long commerceNotificationTemplateId)

updateCommerceNotificationQueueEntry

@Indexable(type=REINDEX)
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

@Indexable(type=REINDEX)
CommerceNotificationQueueEntry updateSent(long commerceNotificationQueueEntryId,
                                                                   boolean sent)
                                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException