com.liferay.portlet.announcements.service
Class AnnouncementsDeliveryLocalServiceUtil

java.lang.Object
  com.liferay.portlet.announcements.service.AnnouncementsDeliveryLocalServiceUtil

public class AnnouncementsDeliveryLocalServiceUtil
extends Object

The utility for the announcements delivery local service. This utility wraps com.liferay.portlet.announcements.service.impl.AnnouncementsDeliveryLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. 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:

AnnouncementsDeliveryLocalService, com.liferay.portlet.announcements.service.base.AnnouncementsDeliveryLocalServiceBaseImpl, com.liferay.portlet.announcements.service.impl.AnnouncementsDeliveryLocalServiceImpl

Constructor Summary

AnnouncementsDeliveryLocalServiceUtil()

Method Summary

static AnnouncementsDelivery	addAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery) Adds the announcements delivery to the database.
static AnnouncementsDelivery	addUserDelivery(long userId, String type)
static AnnouncementsDelivery	createAnnouncementsDelivery(long deliveryId) Creates a new announcements delivery with the primary key.
static AnnouncementsDelivery	deleteAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery) Deletes the announcements delivery from the database.
static AnnouncementsDelivery	deleteAnnouncementsDelivery(long deliveryId) Deletes the announcements delivery with the primary key from the database.
static void	deleteDeliveries(long userId)
static void	deleteDelivery(AnnouncementsDelivery delivery)
static void	deleteDelivery(long deliveryId)
static void	deleteDelivery(long userId, String type)
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 AnnouncementsDelivery	fetchAnnouncementsDelivery(long deliveryId)
static List<AnnouncementsDelivery>	getAnnouncementsDeliveries(int start, int end) Returns a range of all the announcements deliveries.
static int	getAnnouncementsDeliveriesCount() Returns the number of announcements deliveries.
static AnnouncementsDelivery	getAnnouncementsDelivery(long deliveryId) Returns the announcements delivery with the primary key.
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static AnnouncementsDelivery	getDelivery(long deliveryId)
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static AnnouncementsDeliveryLocalService	getService()
static List<AnnouncementsDelivery>	getUserDeliveries(long userId)
static AnnouncementsDelivery	getUserDelivery(long userId, String type)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(AnnouncementsDeliveryLocalService service) Deprecated.
static AnnouncementsDelivery	updateAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery) Updates the announcements delivery in the database or adds it if it does not yet exist.
static AnnouncementsDelivery	updateAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery, boolean merge) Updates the announcements delivery in the database or adds it if it does not yet exist.
static AnnouncementsDelivery	updateDelivery(long userId, String type, boolean email, boolean sms, boolean website)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnouncementsDeliveryLocalServiceUtil

public AnnouncementsDeliveryLocalServiceUtil()

Method Detail

addAnnouncementsDelivery

public static AnnouncementsDelivery addAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery)
                                                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

createAnnouncementsDelivery

public static 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

public static AnnouncementsDelivery deleteAnnouncementsDelivery(long deliveryId)
                                                         throws PortalException,
                                                                SystemException

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

SystemException - if a system exception occurred

deleteAnnouncementsDelivery

public static AnnouncementsDelivery deleteAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery)
                                                         throws SystemException

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

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.

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.

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

fetchAnnouncementsDelivery

public static AnnouncementsDelivery fetchAnnouncementsDelivery(long deliveryId)
                                                        throws SystemException

Throws:

SystemException

getAnnouncementsDelivery

public static AnnouncementsDelivery getAnnouncementsDelivery(long deliveryId)
                                                      throws PortalException,
                                                             SystemException

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

SystemException - if a system exception occurred

getPersistedModel

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

Throws:

PortalException

SystemException

getAnnouncementsDeliveries

public static List<AnnouncementsDelivery> getAnnouncementsDeliveries(int start,
                                                                     int end)
                                                              throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

getAnnouncementsDeliveriesCount

public static int getAnnouncementsDeliveriesCount()
                                           throws SystemException

Returns the number of announcements deliveries.

Returns:

the number of announcements deliveries

Throws:

SystemException - if a system exception occurred

updateAnnouncementsDelivery

public static AnnouncementsDelivery updateAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery)
                                                         throws SystemException

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

Throws:

SystemException - if a system exception occurred

updateAnnouncementsDelivery

public static AnnouncementsDelivery updateAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery,
                                                                boolean merge)
                                                         throws SystemException

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

merge - whether to merge the announcements delivery with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the announcements delivery 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

addUserDelivery

public static AnnouncementsDelivery addUserDelivery(long userId,
                                                    String type)
                                             throws PortalException,
                                                    SystemException

Throws:

PortalException

SystemException

deleteDeliveries

public static void deleteDeliveries(long userId)
                             throws SystemException

Throws:

SystemException

deleteDelivery

public static void deleteDelivery(AnnouncementsDelivery delivery)
                           throws SystemException

Throws:

SystemException

deleteDelivery

public static void deleteDelivery(long deliveryId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteDelivery

public static void deleteDelivery(long userId,
                                  String type)
                           throws SystemException

Throws:

SystemException

getDelivery

public static AnnouncementsDelivery getDelivery(long deliveryId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getUserDeliveries

public static List<AnnouncementsDelivery> getUserDeliveries(long userId)
                                                     throws PortalException,
                                                            SystemException

Throws:

PortalException

SystemException

getUserDelivery

public static AnnouncementsDelivery getUserDelivery(long userId,
                                                    String type)
                                             throws PortalException,
                                                    SystemException

Throws:

PortalException

SystemException

updateDelivery

public static AnnouncementsDelivery updateDelivery(long userId,
                                                   String type,
                                                   boolean email,
                                                   boolean sms,
                                                   boolean website)
                                            throws PortalException,
                                                   SystemException

Throws:

PortalException

SystemException

getService

public static AnnouncementsDeliveryLocalService getService()

setService

public void setService(AnnouncementsDeliveryLocalService service)

Deprecated.