Liferay 6.1.2-ce-ga3

com.liferay.portlet.announcements.service
Interface AnnouncementsDeliveryLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
AnnouncementsDeliveryLocalServiceWrapper

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

The interface for the announcements delivery local service.

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:
AnnouncementsDeliveryLocalServiceUtil, com.liferay.portlet.announcements.service.base.AnnouncementsDeliveryLocalServiceBaseImpl, com.liferay.portlet.announcements.service.impl.AnnouncementsDeliveryLocalServiceImpl

Method Summary
 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)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 AnnouncementsDelivery fetchAnnouncementsDelivery(long deliveryId)
           
 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.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 AnnouncementsDelivery getDelivery(long deliveryId)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<AnnouncementsDelivery> getUserDeliveries(long userId)
           
 AnnouncementsDelivery getUserDelivery(long userId, String type)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 AnnouncementsDelivery updateAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery)
          Updates the announcements delivery in the database or adds it if it does not yet exist.
 AnnouncementsDelivery updateAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery, boolean merge)
          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, boolean website)
           
 

Method Detail

addAnnouncementsDelivery

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

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsDelivery fetchAnnouncementsDelivery(long deliveryId)
                                                 throws SystemException
Throws:
SystemException

getAnnouncementsDelivery

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getAnnouncementsDeliveries

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAnnouncementsDeliveriesCount()
                                    throws SystemException
Returns the number of announcements deliveries.

Returns:
the number of announcements deliveries
Throws:
SystemException - if a system exception occurred

updateAnnouncementsDelivery

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

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

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addUserDelivery

AnnouncementsDelivery addUserDelivery(long userId,
                                      String type)
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

deleteDeliveries

void deleteDeliveries(long userId)
                      throws SystemException
Throws:
SystemException

deleteDelivery

void deleteDelivery(AnnouncementsDelivery delivery)
                    throws SystemException
Throws:
SystemException

deleteDelivery

void deleteDelivery(long deliveryId)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

deleteDelivery

void deleteDelivery(long userId,
                    String type)
                    throws SystemException
Throws:
SystemException

getDelivery

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

getUserDeliveries

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

getUserDelivery

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

updateDelivery

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

Liferay 6.1.2-ce-ga3