com.liferay.announcements.kernel.service

Interface AnnouncementsDeliveryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

AnnouncementsDeliveryLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AnnouncementsDeliveryLocalService
extends BaseLocalService, PersistedModelLocalService

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

AnnouncementsDeliveryLocalServiceUtil, AnnouncementsDeliveryLocalServiceBaseImpl, AnnouncementsDeliveryLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
AnnouncementsDelivery	addAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery) Adds the announcements delivery to the database.
AnnouncementsDelivery	addUserDelivery(long userId, String type)
AnnouncementsDelivery	createAnnouncementsDelivery(long deliveryId) Creates a new announcements delivery with the primary key.
AnnouncementsDelivery	deleteAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery) Deletes the announcements delivery from the database.
AnnouncementsDelivery	deleteAnnouncementsDelivery(long deliveryId) Deletes the announcements delivery with the primary key from the database.
void	deleteDeliveries(long userId)
void	deleteDelivery(AnnouncementsDelivery delivery)
void	deleteDelivery(long deliveryId)
void	deleteDelivery(long userId, String type)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> 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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
AnnouncementsDelivery	fetchAnnouncementsDelivery(long deliveryId)
ActionableDynamicQuery	getActionableDynamicQuery()
List<AnnouncementsDelivery>	getAnnouncementsDeliveries(int start, int end) Returns a range of all the announcements deliveries.
int	getAnnouncementsDeliveriesCount() Returns the number of announcements deliveries.
AnnouncementsDelivery	getAnnouncementsDelivery(long deliveryId) Returns the announcements delivery with the primary key.
AnnouncementsDelivery	getDelivery(long deliveryId)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<AnnouncementsDelivery>	getUserDeliveries(long userId)
AnnouncementsDelivery	getUserDelivery(long userId, String type)
AnnouncementsDelivery	updateAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery) Updates the announcements delivery in the database or adds it if it does not yet exist.
AnnouncementsDelivery	updateDelivery(long userId, String type, boolean email, boolean sms)
AnnouncementsDelivery	updateDelivery(long userId, String type, boolean email, boolean sms, boolean website) Deprecated. As of 7.0.0, replaced by updateDelivery(long, String, boolean, boolean)

Method Detail

addAnnouncementsDelivery

@Indexable(type=REINDEX)
AnnouncementsDelivery addAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery)

Adds the announcements delivery to the database. Also notifies the appropriate model listeners.

Parameters:

announcementsDelivery - the announcements delivery

Returns:

the announcements delivery that was added

addUserDelivery

AnnouncementsDelivery addUserDelivery(long userId,
                                      String type)
                               throws PortalException

Throws:

PortalException

createAnnouncementsDelivery

@Transactional(enabled=false)
AnnouncementsDelivery createAnnouncementsDelivery(long deliveryId)

Creates a new announcements delivery with the primary key. Does not add the announcements delivery to the database.

Parameters:

deliveryId - the primary key for the new announcements delivery

Returns:

the new announcements delivery

deleteAnnouncementsDelivery

@Indexable(type=DELETE)
AnnouncementsDelivery deleteAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery)

Deletes the announcements delivery from the database. Also notifies the appropriate model listeners.

Parameters:

announcementsDelivery - the announcements delivery

Returns:

the announcements delivery that was removed

deleteAnnouncementsDelivery

@Indexable(type=DELETE)
AnnouncementsDelivery deleteAnnouncementsDelivery(long deliveryId)
                                                                   throws PortalException

Deletes the announcements delivery with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

deliveryId - the primary key of the announcements delivery

Returns:

the announcements delivery that was removed

Throws:

PortalException - if a announcements delivery with the primary key could not be found

deleteDeliveries

void deleteDeliveries(long userId)

deleteDelivery

void deleteDelivery(AnnouncementsDelivery delivery)

deleteDelivery

void deleteDelivery(long deliveryId)
             throws PortalException

Throws:

PortalException

deleteDelivery

void deleteDelivery(long userId,
                    String type)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

fetchAnnouncementsDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsDelivery fetchAnnouncementsDelivery(long deliveryId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getAnnouncementsDeliveries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsDelivery> getAnnouncementsDeliveries(int start,
                                                                                                                          int end)

Returns a range of all the announcements 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 AnnouncementsDeliveryModelImpl. 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 announcements deliveries

end - the upper bound of the range of announcements deliveries (not inclusive)

Returns:

the range of announcements deliveries

getAnnouncementsDeliveriesCount

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

Returns the number of announcements deliveries.

Returns:

the number of announcements deliveries

getAnnouncementsDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsDelivery getAnnouncementsDelivery(long deliveryId)
                                                                                                           throws PortalException

Returns the announcements delivery with the primary key.

Parameters:

deliveryId - the primary key of the announcements delivery

Returns:

the announcements delivery

Throws:

PortalException - if a announcements delivery with the primary key could not be found

getDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsDelivery getDelivery(long deliveryId)
                                                                                              throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getUserDeliveries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsDelivery> getUserDeliveries(long userId)
                                                                                                          throws PortalException

Throws:

PortalException

getUserDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsDelivery getUserDelivery(long userId,
                                                                                                         String type)
                                                                                                  throws PortalException

Throws:

PortalException

updateAnnouncementsDelivery

@Indexable(type=REINDEX)
AnnouncementsDelivery updateAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery)

Updates the announcements delivery in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

announcementsDelivery - the announcements delivery

Returns:

the announcements delivery that was updated

updateDelivery

AnnouncementsDelivery updateDelivery(long userId,
                                     String type,
                                     boolean email,
                                     boolean sms)
                              throws PortalException

Throws:

PortalException

updateDelivery

@Deprecated
AnnouncementsDelivery updateDelivery(long userId,
                                                 String type,
                                                 boolean email,
                                                 boolean sms,
                                                 boolean website)
                                          throws PortalException

Deprecated. As of 7.0.0, replaced by updateDelivery(long, String, boolean, boolean)

Throws:

PortalException