com.liferay.portal.kernel.service

Interface SubscriptionLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

SubscriptionLocalServiceWrapper

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

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

SubscriptionLocalServiceUtil, SubscriptionLocalServiceBaseImpl, SubscriptionLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Subscription	addSubscription(long userId, long groupId, String className, long classPK) Subscribes the user to the entity, notifying him the instant the entity is created, deleted, or modified.
Subscription	addSubscription(long userId, long groupId, String className, long classPK, String frequency) Subscribes the user to the entity, notifying him at the given frequency.
Subscription	addSubscription(Subscription subscription) Adds the subscription to the database.
Subscription	createSubscription(long subscriptionId) Creates a new subscription with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
Subscription	deleteSubscription(long subscriptionId) Deletes the subscription with the primary key from the database.
void	deleteSubscription(long userId, String className, long classPK) Deletes the user's subscription to the entity.
Subscription	deleteSubscription(Subscription subscription) Deletes the subscription from the database.
void	deleteSubscriptions(long userId) Deletes all the subscriptions of the user.
void	deleteSubscriptions(long userId, long groupId)
void	deleteSubscriptions(long companyId, String className, long classPK) Deletes all the subscriptions to the entity.
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.
Subscription	fetchSubscription(long subscriptionId)
Subscription	fetchSubscription(long companyId, long userId, String className, long classPK)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
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) Returns the subscription of the user to the entity.
List<Subscription>	getSubscriptions(int start, int end) Returns a range of all the subscriptions.
List<Subscription>	getSubscriptions(long companyId, long userId, String className, long[] classPKs) Returns all the subscriptions of the user to the entities.
List<Subscription>	getSubscriptions(long companyId, String className, long classPK) Returns all the subscriptions to the entity.
int	getSubscriptionsCount() Returns the number of subscriptions.
List<Subscription>	getUserSubscriptions(long userId, int start, int end, OrderByComparator<Subscription> orderByComparator) Returns an ordered range of all the subscriptions of the user.
List<Subscription>	getUserSubscriptions(long userId, String className) Returns all the subscriptions of the user to the entities with the class name.
int	getUserSubscriptionsCount(long userId) Returns the number of subscriptions of the user.
boolean	isSubscribed(long companyId, long userId, String className, long classPK) Returns true if the user is subscribed to the entity.
boolean	isSubscribed(long companyId, long userId, String className, long[] classPKs) Returns true if the user is subscribed to any of the entities.
Subscription	updateSubscription(Subscription subscription) Updates the subscription in the database or adds it if it does not yet exist.

Method Detail

addSubscription

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

Subscribes the user to the entity, notifying him the instant the entity is created, deleted, or modified.

If there is no asset entry with the class name and class PK a new asset entry is created.

A social activity for the subscription is created using the asset entry associated with the class name and class PK, or the newly created asset entry.

Parameters:

userId - the primary key of the user

groupId - the primary key of the entity's group

className - the entity's class name

classPK - the primary key of the entity's instance

Returns:

the subscription

Throws:

PortalException

addSubscription

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

Subscribes the user to the entity, notifying him at the given frequency.

If there is no asset entry with the class name and class PK a new asset entry is created.

A social activity for the subscription is created using the asset entry associated with the class name and class PK, or the newly created asset entry.

Parameters:

userId - the primary key of the user

groupId - the primary key of the entity's group

className - the entity's class name

classPK - the primary key of the entity's instance

frequency - the frequency for notifications

Returns:

the subscription

Throws:

PortalException

addSubscription

@Indexable(type=REINDEX)
Subscription addSubscription(Subscription subscription)

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

Parameters:

subscription - the subscription

Returns:

the subscription that was added

createSubscription

@Transactional(enabled=false)
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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteSubscription

@Indexable(type=DELETE)
Subscription deleteSubscription(long subscriptionId)
                                                 throws PortalException

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

deleteSubscription

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

Deletes the user's subscription to the entity. A social activity with the unsubscribe action is created.

Parameters:

userId - the primary key of the user

className - the entity's class name

classPK - the primary key of the entity's instance

Throws:

PortalException

deleteSubscription

@Indexable(type=DELETE)
Subscription deleteSubscription(Subscription subscription)
                                                 throws PortalException

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

Parameters:

subscription - the subscription

Returns:

the subscription that was removed

Throws:

PortalException

deleteSubscriptions

void deleteSubscriptions(long userId)
                  throws PortalException

Deletes all the subscriptions of the user.

Parameters:

userId - the primary key of the user

Throws:

PortalException

deleteSubscriptions

void deleteSubscriptions(long userId,
                         long groupId)
                  throws PortalException

Throws:

PortalException

deleteSubscriptions

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

Deletes all the subscriptions to the entity.

Parameters:

companyId - the primary key of the company

className - the entity's class name

classPK - the primary key of the entity's instance

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

fetchSubscription

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

fetchSubscription

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Subscription fetchSubscription(long companyId,
                                                                                                  long userId,
                                                                                                  String className,
                                                                                                  long classPK)

getActionableDynamicQuery

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

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

getSubscription

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

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

getSubscription

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

Returns the subscription of the user to the entity.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

className - the entity's class name

classPK - the primary key of the entity's instance

Returns:

the subscription of the user to the entity

Throws:

PortalException

getSubscriptions

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

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. 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 SubscriptionModelImpl. 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 subscriptions

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

Returns:

the range of subscriptions

getSubscriptions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Subscription> getSubscriptions(long companyId,
                                                                                                       long userId,
                                                                                                       String className,
                                                                                                       long[] classPKs)

Returns all the subscriptions of the user to the entities.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

className - the entity's class name

classPKs - the primary key of the entities

Returns:

the subscriptions of the user to the entities

getSubscriptions

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

Returns all the subscriptions to the entity.

Parameters:

companyId - the primary key of the company

className - the entity's class name

classPK - the primary key of the entity's instance

Returns:

the subscriptions to the entity

getSubscriptionsCount

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

Returns the number of subscriptions.

Returns:

the number of subscriptions

getUserSubscriptions

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

Returns an ordered range of all the subscriptions of the user.

Parameters:

userId - the primary key of the user

start - the lower bound of the range of results

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

orderByComparator - the comparator to order the subscriptions

Returns:

the range of subscriptions of the user

getUserSubscriptions

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

Returns all the subscriptions of the user to the entities with the class name.

Parameters:

userId - the primary key of the user

className - the entity's class name

Returns:

the subscriptions of the user to the entities with the class name

getUserSubscriptionsCount

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

Returns the number of subscriptions of the user.

Parameters:

userId - the primary key of the user

Returns:

the number of subscriptions of the user

isSubscribed

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

Returns true if the user is subscribed to the entity.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

className - the entity's class name

classPK - the primary key of the entity's instance

Returns:

true if the user is subscribed to the entity; false otherwise

isSubscribed

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isSubscribed(long companyId,
                                                                                        long userId,
                                                                                        String className,
                                                                                        long[] classPKs)

Returns true if the user is subscribed to any of the entities.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

className - the entity's class name

classPKs - the primary key of the entities

Returns:

true if the user is subscribed to any of the entities; false otherwise

updateSubscription

@Indexable(type=REINDEX)
Subscription updateSubscription(Subscription subscription)

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