Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface UserNotificationDeliveryLocalService

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

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

Provides the local service interface for UserNotificationDelivery. 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:
UserNotificationDeliveryLocalServiceUtil, UserNotificationDeliveryLocalServiceBaseImpl, com.liferay.portal.service.impl.UserNotificationDeliveryLocalServiceImpl

Method Summary
 UserNotificationDelivery addUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver)
           
 UserNotificationDelivery addUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)
          Adds the user notification delivery to the database.
 UserNotificationDelivery createUserNotificationDelivery(long userNotificationDeliveryId)
          Creates a new user notification delivery with the primary key.
 void deleteUserNotificationDeliveries(long userId)
           
 UserNotificationDelivery deleteUserNotificationDelivery(long userNotificationDeliveryId)
          Deletes the user notification delivery with the primary key from the database.
 void deleteUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType)
           
 UserNotificationDelivery deleteUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)
          Deletes the user notification delivery from the database.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 UserNotificationDelivery fetchUserNotificationDelivery(long userNotificationDeliveryId)
           
 UserNotificationDelivery fetchUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<UserNotificationDelivery> getUserNotificationDeliveries(int start, int end)
          Returns a range of all the user notification deliveries.
 int getUserNotificationDeliveriesCount()
          Returns the number of user notification deliveries.
 UserNotificationDelivery getUserNotificationDelivery(long userNotificationDeliveryId)
          Returns the user notification delivery with the primary key.
 UserNotificationDelivery getUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 UserNotificationDelivery updateUserNotificationDelivery(long userNotificationDeliveryId, boolean deliver)
           
 UserNotificationDelivery updateUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)
          Updates the user notification delivery in the database or adds it if it does not yet exist.
 

Method Detail

addUserNotificationDelivery

@Indexable(type=REINDEX)
UserNotificationDelivery addUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)
                                                     throws SystemException
Adds the user notification delivery to the database. Also notifies the appropriate model listeners.

Parameters:
userNotificationDelivery - the user notification delivery
Returns:
the user notification delivery that was added
Throws:
SystemException - if a system exception occurred

createUserNotificationDelivery

UserNotificationDelivery createUserNotificationDelivery(long userNotificationDeliveryId)
Creates a new user notification delivery with the primary key. Does not add the user notification delivery to the database.

Parameters:
userNotificationDeliveryId - the primary key for the new user notification delivery
Returns:
the new user notification delivery

deleteUserNotificationDelivery

@Indexable(type=DELETE)
UserNotificationDelivery deleteUserNotificationDelivery(long userNotificationDeliveryId)
                                                        throws PortalException,
                                                               SystemException
Deletes the user notification delivery with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
userNotificationDeliveryId - the primary key of the user notification delivery
Returns:
the user notification delivery that was removed
Throws:
PortalException - if a user notification delivery with the primary key could not be found
SystemException - if a system exception occurred

deleteUserNotificationDelivery

@Indexable(type=DELETE)
UserNotificationDelivery deleteUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)
                                                        throws SystemException
Deletes the user notification delivery from the database. Also notifies the appropriate model listeners.

Parameters:
userNotificationDelivery - the user notification delivery
Returns:
the user notification 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. 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 UserNotificationDeliveryModelImpl. 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
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. 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 UserNotificationDeliveryModelImpl. 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
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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchUserNotificationDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationDelivery fetchUserNotificationDelivery(long userNotificationDeliveryId)
                                                       throws SystemException
Throws:
SystemException

getUserNotificationDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationDelivery getUserNotificationDelivery(long userNotificationDeliveryId)
                                                     throws PortalException,
                                                            SystemException
Returns the user notification delivery with the primary key.

Parameters:
userNotificationDeliveryId - the primary key of the user notification delivery
Returns:
the user notification delivery
Throws:
PortalException - if a user notification 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

getUserNotificationDeliveries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationDelivery> getUserNotificationDeliveries(int start,
                                                                                                      int end)
                                                             throws SystemException
Returns a range of all the user notification 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 UserNotificationDeliveryModelImpl. 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 user notification deliveries
end - the upper bound of the range of user notification deliveries (not inclusive)
Returns:
the range of user notification deliveries
Throws:
SystemException - if a system exception occurred

getUserNotificationDeliveriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserNotificationDeliveriesCount()
                                       throws SystemException
Returns the number of user notification deliveries.

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

updateUserNotificationDelivery

@Indexable(type=REINDEX)
UserNotificationDelivery updateUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)
                                                        throws SystemException
Updates the user notification delivery in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
userNotificationDelivery - the user notification delivery
Returns:
the user notification 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

addUserNotificationDelivery

UserNotificationDelivery addUserNotificationDelivery(long userId,
                                                     String portletId,
                                                     long classNameId,
                                                     int notificationType,
                                                     int deliveryType,
                                                     boolean deliver)
                                                     throws PortalException,
                                                            SystemException
Throws:
PortalException
SystemException

deleteUserNotificationDeliveries

void deleteUserNotificationDeliveries(long userId)
                                      throws SystemException
Throws:
SystemException

deleteUserNotificationDelivery

void deleteUserNotificationDelivery(long userId,
                                    String portletId,
                                    long classNameId,
                                    int notificationType,
                                    int deliveryType)
                                    throws SystemException
Throws:
SystemException

fetchUserNotificationDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationDelivery fetchUserNotificationDelivery(long userId,
                                                                                                String portletId,
                                                                                                long classNameId,
                                                                                                int notificationType,
                                                                                                int deliveryType)
                                                       throws SystemException
Throws:
SystemException

getUserNotificationDelivery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationDelivery getUserNotificationDelivery(long userId,
                                                                                              String portletId,
                                                                                              long classNameId,
                                                                                              int notificationType,
                                                                                              int deliveryType,
                                                                                              boolean deliver)
                                                     throws PortalException,
                                                            SystemException
Throws:
PortalException
SystemException

updateUserNotificationDelivery

UserNotificationDelivery updateUserNotificationDelivery(long userNotificationDeliveryId,
                                                        boolean deliver)
                                                        throws SystemException
Throws:
SystemException

Liferay 6.2-ce-ga5