com.liferay.portal.kernel.service

Class SubscriptionLocalServiceWrapper

Object

com.liferay.portal.kernel.service.SubscriptionLocalServiceWrapper

All Implemented Interfaces:

BaseLocalService, PersistedModelLocalService, ServiceWrapper<SubscriptionLocalService>, SubscriptionLocalService

@ProviderType
public class SubscriptionLocalServiceWrapper
extends Object
implements SubscriptionLocalService, ServiceWrapper<SubscriptionLocalService>

Provides a wrapper for SubscriptionLocalService.

Author:

Brian Wing Shun Chan

See Also:

SubscriptionLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
SubscriptionLocalServiceWrapper(SubscriptionLocalService subscriptionLocalService)

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.
SubscriptionLocalService	getWrappedService()
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.
void	setWrappedService(SubscriptionLocalService subscriptionLocalService)
Subscription	updateSubscription(Subscription subscription) Updates the subscription in the database or adds it if it does not yet exist.

Methods inherited from class Object

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

Constructor Detail

SubscriptionLocalServiceWrapper

public SubscriptionLocalServiceWrapper(SubscriptionLocalService subscriptionLocalService)

Method Detail

addSubscription

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

Specified by:

addSubscription in interface SubscriptionLocalService

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

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

Specified by:

addSubscription in interface SubscriptionLocalService

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

public Subscription addSubscription(Subscription subscription)

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

Specified by:

addSubscription in interface SubscriptionLocalService

Parameters:

subscription - the subscription

Returns:

the subscription that was added

createSubscription

public Subscription createSubscription(long subscriptionId)

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

Specified by:

createSubscription in interface SubscriptionLocalService

Parameters:

subscriptionId - the primary key for the new subscription

Returns:

the new subscription

deletePersistedModel

public PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Specified by:

deletePersistedModel in interface SubscriptionLocalService

Throws:

PortalException

deleteSubscription

public Subscription deleteSubscription(long subscriptionId)
                                throws PortalException

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

Specified by:

deleteSubscription in interface SubscriptionLocalService

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

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

Specified by:

deleteSubscription in interface SubscriptionLocalService

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

public Subscription deleteSubscription(Subscription subscription)
                                throws PortalException

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

Specified by:

deleteSubscription in interface SubscriptionLocalService

Parameters:

subscription - the subscription

Returns:

the subscription that was removed

Throws:

PortalException

deleteSubscriptions

public void deleteSubscriptions(long userId)
                         throws PortalException

Deletes all the subscriptions of the user.

Specified by:

deleteSubscriptions in interface SubscriptionLocalService

Parameters:

userId - the primary key of the user

Throws:

PortalException

deleteSubscriptions

public void deleteSubscriptions(long userId,
                                long groupId)
                         throws PortalException

Specified by:

deleteSubscriptions in interface SubscriptionLocalService

Throws:

PortalException

deleteSubscriptions

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

Deletes all the subscriptions to the entity.

Specified by:

deleteSubscriptions in interface SubscriptionLocalService

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

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface SubscriptionLocalService

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Specified by:

dynamicQuery in interface SubscriptionLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

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

Specified by:

dynamicQuery in interface SubscriptionLocalService

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

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

Specified by:

dynamicQuery in interface SubscriptionLocalService

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

public long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface SubscriptionLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface SubscriptionLocalService

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchSubscription

public Subscription fetchSubscription(long subscriptionId)

Specified by:

fetchSubscription in interface SubscriptionLocalService

fetchSubscription

public Subscription fetchSubscription(long companyId,
                                      long userId,
                                      String className,
                                      long classPK)

Specified by:

fetchSubscription in interface SubscriptionLocalService

getActionableDynamicQuery

public ActionableDynamicQuery getActionableDynamicQuery()

Specified by:

getActionableDynamicQuery in interface SubscriptionLocalService

getIndexableActionableDynamicQuery

public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

Specified by:

getIndexableActionableDynamicQuery in interface SubscriptionLocalService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface SubscriptionLocalService

Returns:

the OSGi service identifier

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Specified by:

getPersistedModel in interface SubscriptionLocalService

Throws:

PortalException

getSubscription

public Subscription getSubscription(long subscriptionId)
                             throws PortalException

Returns the subscription with the primary key.

Specified by:

getSubscription in interface SubscriptionLocalService

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

public Subscription getSubscription(long companyId,
                                    long userId,
                                    String className,
                                    long classPK)
                             throws PortalException

Returns the subscription of the user to the entity.

Specified by:

getSubscription in interface SubscriptionLocalService

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

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

Specified by:

getSubscriptions in interface SubscriptionLocalService

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

public List<Subscription> getSubscriptions(long companyId,
                                           long userId,
                                           String className,
                                           long[] classPKs)

Returns all the subscriptions of the user to the entities.

Specified by:

getSubscriptions in interface SubscriptionLocalService

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

public List<Subscription> getSubscriptions(long companyId,
                                           String className,
                                           long classPK)

Returns all the subscriptions to the entity.

Specified by:

getSubscriptions in interface SubscriptionLocalService

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

public int getSubscriptionsCount()

Returns the number of subscriptions.

Specified by:

getSubscriptionsCount in interface SubscriptionLocalService

Returns:

the number of subscriptions

getUserSubscriptions

public List<Subscription> getUserSubscriptions(long userId,
                                               int start,
                                               int end,
                                               OrderByComparator<Subscription> orderByComparator)

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

Specified by:

getUserSubscriptions in interface SubscriptionLocalService

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

public List<Subscription> getUserSubscriptions(long userId,
                                               String className)

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

Specified by:

getUserSubscriptions in interface SubscriptionLocalService

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

public int getUserSubscriptionsCount(long userId)

Returns the number of subscriptions of the user.

Specified by:

getUserSubscriptionsCount in interface SubscriptionLocalService

Parameters:

userId - the primary key of the user

Returns:

the number of subscriptions of the user

isSubscribed

public boolean isSubscribed(long companyId,
                            long userId,
                            String className,
                            long classPK)

Returns true if the user is subscribed to the entity.

Specified by:

isSubscribed in interface SubscriptionLocalService

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

public boolean isSubscribed(long companyId,
                            long userId,
                            String className,
                            long[] classPKs)

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

Specified by:

isSubscribed in interface SubscriptionLocalService

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

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

Specified by:

updateSubscription in interface SubscriptionLocalService

Parameters:

subscription - the subscription

Returns:

the subscription that was updated

getWrappedService

public SubscriptionLocalService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<SubscriptionLocalService>

setWrappedService

public void setWrappedService(SubscriptionLocalService subscriptionLocalService)

Specified by:

setWrappedService in interface ServiceWrapper<SubscriptionLocalService>