com.liferay.portal.service.SubscriptionLocalServiceWrapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service;
import aQute.bnd.annotation.ProviderType;
/**
* Provides a wrapper for {@link SubscriptionLocalService}.
*
* @author Brian Wing Shun Chan
* @see SubscriptionLocalService
* @generated
*/
@ProviderType
public class SubscriptionLocalServiceWrapper implements SubscriptionLocalService,
ServiceWrapper {
public SubscriptionLocalServiceWrapper(
SubscriptionLocalService subscriptionLocalService) {
_subscriptionLocalService = subscriptionLocalService;
}
/**
* Adds the subscription to the database. Also notifies the appropriate model listeners.
*
* @param subscription the subscription
* @return the subscription that was added
* @throws SystemException if a system exception occurred
*/
@Override
public com.liferay.portal.model.Subscription addSubscription(
com.liferay.portal.model.Subscription subscription)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.addSubscription(subscription);
}
/**
* Creates a new subscription with the primary key. Does not add the subscription to the database.
*
* @param subscriptionId the primary key for the new subscription
* @return the new subscription
*/
@Override
public com.liferay.portal.model.Subscription createSubscription(
long subscriptionId) {
return _subscriptionLocalService.createSubscription(subscriptionId);
}
/**
* Deletes the subscription with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param subscriptionId the primary key of the subscription
* @return the subscription that was removed
* @throws PortalException if a subscription with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@Override
public com.liferay.portal.model.Subscription deleteSubscription(
long subscriptionId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.deleteSubscription(subscriptionId);
}
/**
* Deletes the subscription from the database. Also notifies the appropriate model listeners.
*
* @param subscription the subscription
* @return the subscription that was removed
* @throws PortalException
* @throws SystemException if a system exception occurred
*/
@Override
public com.liferay.portal.model.Subscription deleteSubscription(
com.liferay.portal.model.Subscription subscription)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.deleteSubscription(subscription);
}
@Override
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
return _subscriptionLocalService.dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@Override
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.dynamicQuery(dynamicQuery);
}
/**
* 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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
* @throws SystemException if a system exception occurred
*/
@Override
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.dynamicQuery(dynamicQuery, start, end);
}
/**
* 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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
* @throws SystemException if a system exception occurred
*/
@Override
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.dynamicQuery(dynamicQuery, start, end,
orderByComparator);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
@Override
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
@Override
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.dynamicQueryCount(dynamicQuery,
projection);
}
@Override
public com.liferay.portal.model.Subscription fetchSubscription(
long subscriptionId)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.fetchSubscription(subscriptionId);
}
/**
* Returns the subscription with the primary key.
*
* @param subscriptionId the primary key of the subscription
* @return the subscription
* @throws PortalException if a subscription with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@Override
public com.liferay.portal.model.Subscription getSubscription(
long subscriptionId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.getSubscription(subscriptionId);
}
@Override
public com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.getPersistedModel(primaryKeyObj);
}
/**
* 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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of subscriptions
* @param end the upper bound of the range of subscriptions (not inclusive)
* @return the range of subscriptions
* @throws SystemException if a system exception occurred
*/
@Override
public java.util.List getSubscriptions(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.getSubscriptions(start, end);
}
/**
* Returns the number of subscriptions.
*
* @return the number of subscriptions
* @throws SystemException if a system exception occurred
*/
@Override
public int getSubscriptionsCount()
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.getSubscriptionsCount();
}
/**
* Updates the subscription in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param subscription the subscription
* @return the subscription that was updated
* @throws SystemException if a system exception occurred
*/
@Override
public com.liferay.portal.model.Subscription updateSubscription(
com.liferay.portal.model.Subscription subscription)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.updateSubscription(subscription);
}
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
@Override
public java.lang.String getBeanIdentifier() {
return _subscriptionLocalService.getBeanIdentifier();
}
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
@Override
public void setBeanIdentifier(java.lang.String beanIdentifier) {
_subscriptionLocalService.setBeanIdentifier(beanIdentifier);
}
/**
* 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.
*
*
* @param userId the primary key of the user
* @param groupId the primary key of the entity's group
* @param className the entity's class name
* @param classPK the primary key of the entity's instance
* @return the subscription
* @throws PortalException if a matching user or group could not be found
* @throws SystemException if a system exception occurred
*/
@Override
public com.liferay.portal.model.Subscription addSubscription(long userId,
long groupId, java.lang.String className, long classPK)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.addSubscription(userId, groupId,
className, classPK);
}
/**
* 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.
*
*
* @param userId the primary key of the user
* @param groupId the primary key of the entity's group
* @param className the entity's class name
* @param classPK the primary key of the entity's instance
* @param frequency the frequency for notifications
* @return the subscription
* @throws PortalException if a matching user or group could not be found
* @throws SystemException if a system exception occurred
*/
@Override
public com.liferay.portal.model.Subscription addSubscription(long userId,
long groupId, java.lang.String className, long classPK,
java.lang.String frequency)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.addSubscription(userId, groupId,
className, classPK, frequency);
}
/**
* Deletes the user's subscription to the entity. A social activity with the
* unsubscribe action is created.
*
* @param userId the primary key of the user
* @param className the entity's class name
* @param classPK the primary key of the entity's instance
* @throws PortalException if a matching user or subscription could not be
found
* @throws SystemException if a system exception occurred
*/
@Override
public void deleteSubscription(long userId, java.lang.String className,
long classPK)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
_subscriptionLocalService.deleteSubscription(userId, className, classPK);
}
/**
* Deletes all the subscriptions of the user.
*
* @param userId the primary key of the user
* @throws PortalException if a portal exception occurred
* @throws SystemException if a system exception occurred
*/
@Override
public void deleteSubscriptions(long userId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
_subscriptionLocalService.deleteSubscriptions(userId);
}
/**
* Deletes all the subscriptions to the entity.
*
* @param companyId the primary key of the company
* @param className the entity's class name
* @param classPK the primary key of the entity's instance
* @throws PortalException if a portal exception occurred
* @throws SystemException if a system exception occurred
*/
@Override
public void deleteSubscriptions(long companyId, java.lang.String className,
long classPK)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
_subscriptionLocalService.deleteSubscriptions(companyId, className,
classPK);
}
/**
* Returns the subscription of the user to the entity.
*
* @param companyId the primary key of the company
* @param userId the primary key of the user
* @param className the entity's class name
* @param classPK the primary key of the entity's instance
* @return the subscription of the user to the entity
* @throws PortalException if a matching subscription could not be found
* @throws SystemException if a system exception occurred
*/
@Override
public com.liferay.portal.model.Subscription getSubscription(
long companyId, long userId, java.lang.String className, long classPK)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.getSubscription(companyId, userId,
className, classPK);
}
/**
* Returns all the subscriptions of the user to the entities.
*
* @param companyId the primary key of the company
* @param userId the primary key of the user
* @param className the entity's class name
* @param classPKs the primary key of the entities
* @return the subscriptions of the user to the entities
* @throws SystemException if a system exception occurred
*/
@Override
public java.util.List getSubscriptions(
long companyId, long userId, java.lang.String className, long[] classPKs)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.getSubscriptions(companyId, userId,
className, classPKs);
}
/**
* Returns all the subscriptions to the entity.
*
* @param companyId the primary key of the company
* @param className the entity's class name
* @param classPK the primary key of the entity's instance
* @return the subscriptions to the entity
* @throws SystemException if a system exception occurred
*/
@Override
public java.util.List getSubscriptions(
long companyId, java.lang.String className, long classPK)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.getSubscriptions(companyId, className,
classPK);
}
/**
* Returns an ordered range of all the subscriptions of the user.
*
* @param userId the primary key of the user
* @param start the lower bound of the range of results
* @param end the upper bound of the range of results (not inclusive)
* @param orderByComparator the comparator to order the subscriptions
* @return the range of subscriptions of the user
* @throws SystemException if a system exception occurred
*/
@Override
public java.util.List getUserSubscriptions(
long userId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.getUserSubscriptions(userId, start,
end, orderByComparator);
}
/**
* Returns all the subscriptions of the user to the entities with the class
* name.
*
* @param userId the primary key of the user
* @param className the entity's class name
* @return the subscriptions of the user to the entities with the class name
* @throws SystemException if a system exception occurred
*/
@Override
public java.util.List getUserSubscriptions(
long userId, java.lang.String className)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.getUserSubscriptions(userId, className);
}
/**
* Returns the number of subscriptions of the user.
*
* @param userId the primary key of the user
* @return the number of subscriptions of the user
* @throws SystemException if a system exception occurred
*/
@Override
public int getUserSubscriptionsCount(long userId)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.getUserSubscriptionsCount(userId);
}
/**
* Returns true if the user is subscribed to the entity.
*
* @param companyId the primary key of the company
* @param userId the primary key of the user
* @param className the entity's class name
* @param classPK the primary key of the entity's instance
* @return true if the user is subscribed to the entity;
false otherwise
* @throws SystemException if a system exception occurred
*/
@Override
public boolean isSubscribed(long companyId, long userId,
java.lang.String className, long classPK)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.isSubscribed(companyId, userId,
className, classPK);
}
/**
* Returns true if the user is subscribed to any of the
* entities.
*
* @param companyId the primary key of the company
* @param userId the primary key of the user
* @param className the entity's class name
* @param classPKs the primary key of the entities
* @return true if the user is subscribed to any of the
entities; false otherwise
* @throws SystemException if a system exception occurred
*/
@Override
public boolean isSubscribed(long companyId, long userId,
java.lang.String className, long[] classPKs)
throws com.liferay.portal.kernel.exception.SystemException {
return _subscriptionLocalService.isSubscribed(companyId, userId,
className, classPKs);
}
/**
* @deprecated As of 6.1.0, replaced by {@link #getWrappedService}
*/
public SubscriptionLocalService getWrappedSubscriptionLocalService() {
return _subscriptionLocalService;
}
/**
* @deprecated As of 6.1.0, replaced by {@link #setWrappedService}
*/
public void setWrappedSubscriptionLocalService(
SubscriptionLocalService subscriptionLocalService) {
_subscriptionLocalService = subscriptionLocalService;
}
@Override
public SubscriptionLocalService getWrappedService() {
return _subscriptionLocalService;
}
@Override
public void setWrappedService(
SubscriptionLocalService subscriptionLocalService) {
_subscriptionLocalService = subscriptionLocalService;
}
private SubscriptionLocalService _subscriptionLocalService;
}