com.liferay.portal.service
Interface SubscriptionLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

SubscriptionLocalServiceWrapper

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

The interface for the subscription 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:

SubscriptionLocalServiceUtil, SubscriptionLocalServiceBaseImpl, com.liferay.portal.service.impl.SubscriptionLocalServiceImpl

Method Summary

Subscription	addSubscription(long userId, long groupId, String className, long classPK)
Subscription	addSubscription(long userId, long groupId, String className, long classPK, String frequency)
Subscription	addSubscription(Subscription subscription) Adds the subscription to the database.
Subscription	createSubscription(long subscriptionId) Creates a new subscription with the primary key.
Subscription	deleteSubscription(long subscriptionId) Deletes the subscription with the primary key from the database.
void	deleteSubscription(long userId, String className, long classPK)
Subscription	deleteSubscription(Subscription subscription) Deletes the subscription from the database.
void	deleteSubscriptions(long userId)
void	deleteSubscriptions(long companyId, String className, long classPK)
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.
Subscription	fetchSubscription(long subscriptionId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
Subscription	getSubscription(long subscriptionId) Returns the subscription with the primary key.
Subscription	getSubscription(long companyId, long userId, String className, long classPK)
List<Subscription>	getSubscriptions(int start, int end) Returns a range of all the subscriptions.
List<Subscription>	getSubscriptions(long companyId, String className, long classPK)
int	getSubscriptionsCount() Returns the number of subscriptions.
List<Subscription>	getUserSubscriptions(long userId, int start, int end, OrderByComparator orderByComparator)
List<Subscription>	getUserSubscriptions(long userId, String className)
int	getUserSubscriptionsCount(long userId)
boolean	isSubscribed(long companyId, long userId, String className, long classPK)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
Subscription	updateSubscription(Subscription subscription) Updates the subscription in the database or adds it if it does not yet exist.
Subscription	updateSubscription(Subscription subscription, boolean merge) Updates the subscription in the database or adds it if it does not yet exist.

Method Detail

addSubscription

Subscription addSubscription(Subscription subscription)
                             throws SystemException

Adds the subscription to the database. Also notifies the appropriate model listeners.

Parameters:

subscription - the subscription

Returns:

the subscription that was added

Throws:

SystemException - if a system exception occurred

createSubscription

Subscription createSubscription(long subscriptionId)

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

Parameters:

subscriptionId - the primary key for the new subscription

Returns:

the new subscription

deleteSubscription

Subscription deleteSubscription(long subscriptionId)
                                throws PortalException,
                                       SystemException

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

Parameters:

subscriptionId - the primary key of the subscription

Returns:

the subscription that was removed

Throws:

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

SystemException - if a system exception occurred

deleteSubscription

Subscription deleteSubscription(Subscription subscription)
                                throws PortalException,
                                       SystemException

Deletes the subscription from the database. Also notifies the appropriate model listeners.

Parameters:

subscription - the subscription

Returns:

the subscription that was removed

Throws:

PortalException

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

fetchSubscription

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Subscription fetchSubscription(long subscriptionId)
                               throws SystemException

Throws:

SystemException

getSubscription

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Subscription getSubscription(long subscriptionId)
                             throws PortalException,
                                    SystemException

Returns the subscription with the primary key.

Parameters:

subscriptionId - the primary key of the subscription

Returns:

the subscription

Throws:

PortalException - if a subscription 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

getSubscriptions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Subscription> getSubscriptions(int start,
                                                                             int end)
                                    throws SystemException

Returns a range of all the subscriptions.

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 subscriptions

end - the upper bound of the range of subscriptions (not inclusive)

Returns:

the range of subscriptions

Throws:

SystemException - if a system exception occurred

getSubscriptionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSubscriptionsCount()
                          throws SystemException

Returns the number of subscriptions.

Returns:

the number of subscriptions

Throws:

SystemException - if a system exception occurred

updateSubscription

Subscription updateSubscription(Subscription subscription)
                                throws SystemException

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

Parameters:

subscription - the subscription

Returns:

the subscription that was updated

Throws:

SystemException - if a system exception occurred

updateSubscription

Subscription updateSubscription(Subscription subscription,
                                boolean merge)
                                throws SystemException

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

Parameters:

subscription - the subscription

merge - whether to merge the subscription 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 subscription 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

addSubscription

Subscription addSubscription(long userId,
                             long groupId,
                             String className,
                             long classPK)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

addSubscription

Subscription addSubscription(long userId,
                             long groupId,
                             String className,
                             long classPK,
                             String frequency)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

deleteSubscription

void deleteSubscription(long userId,
                        String className,
                        long classPK)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteSubscriptions

void deleteSubscriptions(long userId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

deleteSubscriptions

void deleteSubscriptions(long companyId,
                         String className,
                         long classPK)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getSubscription

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Subscription getSubscription(long companyId,
                                                                      long userId,
                                                                      String className,
                                                                      long classPK)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getSubscriptions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Subscription> getSubscriptions(long companyId,
                                                                             String className,
                                                                             long classPK)
                                    throws SystemException

Throws:

SystemException

getUserSubscriptions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Subscription> getUserSubscriptions(long userId,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator orderByComparator)
                                        throws SystemException

Throws:

SystemException

getUserSubscriptions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Subscription> getUserSubscriptions(long userId,
                                                                                 String className)
                                        throws SystemException

Throws:

SystemException

getUserSubscriptionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserSubscriptionsCount(long userId)
                              throws SystemException

Throws:

SystemException

isSubscribed

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isSubscribed(long companyId,
                                                              long userId,
                                                              String className,
                                                              long classPK)
                     throws SystemException

Throws:

SystemException