Liferay 6.2-ce-ga5

com.liferay.portal.service
Class SubscriptionLocalServiceWrapper

java.lang.Object
  extended by com.liferay.portal.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.

See Also:
SubscriptionLocalService
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
SubscriptionLocalServiceWrapper(SubscriptionLocalService subscriptionLocalService)
           
 
Method Summary
 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.
 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 companyId, String className, long classPK)
          Deletes all the subscriptions to the entity.
 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.
 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)
          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 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()
           
 SubscriptionLocalService getWrappedSubscriptionLocalService()
          Deprecated. As of 6.1.0, replaced by 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 setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setWrappedService(SubscriptionLocalService subscriptionLocalService)
           
 void setWrappedSubscriptionLocalService(SubscriptionLocalService subscriptionLocalService)
          Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.SubscriptionLocalService)
 Subscription updateSubscription(Subscription subscription)
          Updates the subscription in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.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(Subscription subscription)
                             throws SystemException
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
Throws:
SystemException - if a system exception occurred

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

deleteSubscription

public Subscription deleteSubscription(long subscriptionId)
                                throws PortalException,
                                       SystemException
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
SystemException - if a system exception occurred

deleteSubscription

public Subscription deleteSubscription(Subscription subscription)
                                throws PortalException,
                                       SystemException
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
SystemException - if a system exception occurred

dynamicQuery

public DynamicQuery dynamicQuery()
Specified by:
dynamicQuery in interface SubscriptionLocalService

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public 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 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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public 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 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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

Specified by:
dynamicQueryCount in interface SubscriptionLocalService
Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)
                       throws SystemException
Returns the number of rows that match 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 that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchSubscription

public Subscription fetchSubscription(long subscriptionId)
                               throws SystemException
Specified by:
fetchSubscription in interface SubscriptionLocalService
Throws:
SystemException

getSubscription

public Subscription getSubscription(long subscriptionId)
                             throws PortalException,
                                    SystemException
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
SystemException - if a system exception occurred

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Specified by:
getPersistedModel in interface SubscriptionLocalService
Throws:
PortalException
SystemException

getSubscriptions

public 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. 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
Throws:
SystemException - if a system exception occurred

getSubscriptionsCount

public int getSubscriptionsCount()
                          throws SystemException
Returns the number of subscriptions.

Specified by:
getSubscriptionsCount in interface SubscriptionLocalService
Returns:
the number of subscriptions
Throws:
SystemException - if a system exception occurred

updateSubscription

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

Specified by:
updateSubscription in interface SubscriptionLocalService
Parameters:
subscription - the subscription
Returns:
the subscription that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

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

Specified by:
getBeanIdentifier in interface SubscriptionLocalService
Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Specified by:
setBeanIdentifier in interface SubscriptionLocalService
Parameters:
beanIdentifier - the Spring bean ID for this bean

addSubscription

public Subscription addSubscription(long userId,
                                    long groupId,
                                    String className,
                                    long classPK)
                             throws PortalException,
                                    SystemException
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 - if a matching user or group could not be found
SystemException - if a system exception occurred

addSubscription

public Subscription addSubscription(long userId,
                                    long groupId,
                                    String className,
                                    long classPK,
                                    String frequency)
                             throws PortalException,
                                    SystemException
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 - if a matching user or group could not be found
SystemException - if a system exception occurred

deleteSubscription

public void deleteSubscription(long userId,
                               String className,
                               long classPK)
                        throws PortalException,
                               SystemException
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 - if a matching user or subscription could not be found
SystemException - if a system exception occurred

deleteSubscriptions

public void deleteSubscriptions(long userId)
                         throws PortalException,
                                SystemException
Deletes all the subscriptions of the user.

Specified by:
deleteSubscriptions in interface SubscriptionLocalService
Parameters:
userId - the primary key of the user
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

deleteSubscriptions

public void deleteSubscriptions(long companyId,
                                String className,
                                long classPK)
                         throws PortalException,
                                SystemException
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 - if a portal exception occurred
SystemException - if a system exception occurred

getSubscription

public Subscription getSubscription(long companyId,
                                    long userId,
                                    String className,
                                    long classPK)
                             throws PortalException,
                                    SystemException
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 - if a matching subscription could not be found
SystemException - if a system exception occurred

getSubscriptions

public List<Subscription> getSubscriptions(long companyId,
                                           long userId,
                                           String className,
                                           long[] classPKs)
                                    throws SystemException
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
Throws:
SystemException - if a system exception occurred

getSubscriptions

public List<Subscription> getSubscriptions(long companyId,
                                           String className,
                                           long classPK)
                                    throws SystemException
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
Throws:
SystemException - if a system exception occurred

getUserSubscriptions

public List<Subscription> getUserSubscriptions(long userId,
                                               int start,
                                               int end,
                                               OrderByComparator orderByComparator)
                                        throws SystemException
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
Throws:
SystemException - if a system exception occurred

getUserSubscriptions

public List<Subscription> getUserSubscriptions(long userId,
                                               String className)
                                        throws SystemException
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
Throws:
SystemException - if a system exception occurred

getUserSubscriptionsCount

public int getUserSubscriptionsCount(long userId)
                              throws SystemException
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
Throws:
SystemException - if a system exception occurred

isSubscribed

public boolean isSubscribed(long companyId,
                            long userId,
                            String className,
                            long classPK)
                     throws SystemException
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
Throws:
SystemException - if a system exception occurred

isSubscribed

public boolean isSubscribed(long companyId,
                            long userId,
                            String className,
                            long[] classPKs)
                     throws SystemException
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
Throws:
SystemException - if a system exception occurred

getWrappedSubscriptionLocalService

public SubscriptionLocalService getWrappedSubscriptionLocalService()
Deprecated. As of 6.1.0, replaced by getWrappedService()


setWrappedSubscriptionLocalService

public void setWrappedSubscriptionLocalService(SubscriptionLocalService subscriptionLocalService)
Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.SubscriptionLocalService)


getWrappedService

public SubscriptionLocalService getWrappedService()
Specified by:
getWrappedService in interface ServiceWrapper<SubscriptionLocalService>

setWrappedService

public void setWrappedService(SubscriptionLocalService subscriptionLocalService)
Specified by:
setWrappedService in interface ServiceWrapper<SubscriptionLocalService>

Liferay 6.2-ce-ga5