Class SubscriptionLocalServiceWrapper
- All Implemented Interfaces:
com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.change.tracking.CTService<Subscription>,com.liferay.portal.kernel.service.PersistedModelLocalService,com.liferay.portal.kernel.service.ServiceWrapper<SubscriptionLocalService>,SubscriptionLocalService
SubscriptionLocalService.- See Also:
- Generated:
-
Constructor Summary
ConstructorsConstructorDescriptionSubscriptionLocalServiceWrapper(SubscriptionLocalService subscriptionLocalService) -
Method Summary
Modifier and TypeMethodDescriptionaddSubscription(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.addSubscription(long userId, long groupId, String className, long classPK, String frequency) Subscribes the user to the entity, notifying him at the given frequency.addSubscription(Subscription subscription) Adds the subscription to the database.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) createSubscription(long subscriptionId) Creates a new subscription with the primary key.voiddeleteGroupSubscriptions(long groupId) com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) deleteSubscription(long subscriptionId) Deletes the subscription with the primary key from the database.voiddeleteSubscription(long userId, String className, long classPK) Deletes the user's subscription to the entity.deleteSubscription(Subscription subscription) Deletes the subscription from the database.voiddeleteSubscriptions(long userId) Deletes all the subscriptions of the user.voiddeleteSubscriptions(long userId, long groupId) voiddeleteSubscriptions(long companyId, String className, long classPK) Deletes all the subscriptions to the entity.<T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.fetchSubscription(long subscriptionId) fetchSubscription(long companyId, long userId, String className, long classPK) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerycom.liferay.portal.kernel.service.persistence.BasePersistence<?>com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<Subscription>com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQueryReturns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) getSubscription(long subscriptionId) Returns the subscription with the primary key.getSubscription(long companyId, long userId, String className, long classPK) Returns the subscription of the user to the entity.getSubscriptions(int start, int end) Returns a range of all the subscriptions.getSubscriptions(long companyId, long userId, String className, long[] classPKs) Returns all the subscriptions of the user to the entities.getSubscriptions(long companyId, String className, long classPK) Returns all the subscriptions to the entity.getSubscriptions(String className) Deprecated.As of Athanasius (7.3.x), with no direct replacementintReturns the number of subscriptions.intgetSubscriptionsCount(String className) Deprecated.As of Athanasius (7.3.x), with no direct replacementgetUserSubscriptions(long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Subscription> orderByComparator) Returns an ordered range of all the subscriptions of the user.getUserSubscriptions(long userId, String className) Returns all the subscriptions of the user to the entities with the class name.intgetUserSubscriptionsCount(long userId) Returns the number of subscriptions of the user.booleanisSubscribed(long companyId, long userId, String className, long classPK) Returnstrueif the user is subscribed to the entity.booleanisSubscribed(long companyId, long userId, String className, long[] classPKs) Returnstrueif the user is subscribed to any of the entities.voidsetWrappedService(SubscriptionLocalService subscriptionLocalService) updateSubscription(Subscription subscription) Updates the subscription in the database or adds it if it does not yet exist.voidupdateSubscriptions(long companyId, long classNameId, long oldClassPK, long newClassPK) <R,E extends Throwable>
RupdateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<Subscription>, R, E> updateUnsafeFunction) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel
-
Constructor Details
-
SubscriptionLocalServiceWrapper
public SubscriptionLocalServiceWrapper() -
SubscriptionLocalServiceWrapper
-
-
Method Details
-
addSubscription
public Subscription addSubscription(long userId, long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.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:
addSubscriptionin interfaceSubscriptionLocalService- Parameters:
userId- the primary key of the usergroupId- the primary key of the entity's groupclassName- the entity's class nameclassPK- the primary key of the entity's instance- Returns:
- the subscription
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addSubscription
public Subscription addSubscription(long userId, long groupId, String className, long classPK, String frequency) throws com.liferay.portal.kernel.exception.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:
addSubscriptionin interfaceSubscriptionLocalService- Parameters:
userId- the primary key of the usergroupId- the primary key of the entity's groupclassName- the entity's class nameclassPK- the primary key of the entity's instancefrequency- the frequency for notifications- Returns:
- the subscription
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addSubscription
Adds the subscription to the database. Also notifies the appropriate model listeners.Important: Inspect SubscriptionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
addSubscriptionin interfaceSubscriptionLocalService- Parameters:
subscription- the subscription- Returns:
- the subscription that was added
-
createPersistedModel
public com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
createPersistedModelin interfaceSubscriptionLocalService- Throws:
PortalExceptioncom.liferay.portal.kernel.exception.PortalException
-
createSubscription
Creates a new subscription with the primary key. Does not add the subscription to the database.- Specified by:
createSubscriptionin interfaceSubscriptionLocalService- Parameters:
subscriptionId- the primary key for the new subscription- Returns:
- the new subscription
-
deleteGroupSubscriptions
public void deleteGroupSubscriptions(long groupId) - Specified by:
deleteGroupSubscriptionsin interfaceSubscriptionLocalService
-
deletePersistedModel
public com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
deletePersistedModelin interfaceSubscriptionLocalService- Throws:
PortalExceptioncom.liferay.portal.kernel.exception.PortalException
-
deleteSubscription
public Subscription deleteSubscription(long subscriptionId) throws com.liferay.portal.kernel.exception.PortalException Deletes the subscription with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect SubscriptionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
deleteSubscriptionin interfaceSubscriptionLocalService- 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 foundcom.liferay.portal.kernel.exception.PortalException
-
deleteSubscription
public void deleteSubscription(long userId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Deletes the user's subscription to the entity. A social activity with the unsubscribe action is created.- Specified by:
deleteSubscriptionin interfaceSubscriptionLocalService- Parameters:
userId- the primary key of the userclassName- the entity's class nameclassPK- the primary key of the entity's instance- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSubscription
public Subscription deleteSubscription(Subscription subscription) throws com.liferay.portal.kernel.exception.PortalException Deletes the subscription from the database. Also notifies the appropriate model listeners.Important: Inspect SubscriptionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
deleteSubscriptionin interfaceSubscriptionLocalService- Parameters:
subscription- the subscription- Returns:
- the subscription that was removed
- Throws:
PortalExceptioncom.liferay.portal.kernel.exception.PortalException
-
deleteSubscriptions
public void deleteSubscriptions(long userId) throws com.liferay.portal.kernel.exception.PortalException Deletes all the subscriptions of the user.- Specified by:
deleteSubscriptionsin interfaceSubscriptionLocalService- Parameters:
userId- the primary key of the user- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSubscriptions
public void deleteSubscriptions(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteSubscriptionsin interfaceSubscriptionLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSubscriptions
public void deleteSubscriptions(long companyId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Deletes all the subscriptions to the entity.- Specified by:
deleteSubscriptionsin interfaceSubscriptionLocalService- Parameters:
companyId- the primary key of the companyclassName- the entity's class nameclassPK- the primary key of the entity's instance- Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
dslQueryin interfaceSubscriptionLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
dslQueryCountin interfaceSubscriptionLocalService
-
dynamicQuery
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()- Specified by:
dynamicQueryin interfaceSubscriptionLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQueryin interfaceSubscriptionLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.subscription.model.impl.SubscriptionModelImpl.- Specified by:
dynamicQueryin interfaceSubscriptionLocalService- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.subscription.model.impl.SubscriptionModelImpl.- Specified by:
dynamicQueryin interfaceSubscriptionLocalService- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCountin interfaceSubscriptionLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCountin interfaceSubscriptionLocalService- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchSubscription
- Specified by:
fetchSubscriptionin interfaceSubscriptionLocalService
-
fetchSubscription
- Specified by:
fetchSubscriptionin interfaceSubscriptionLocalService
-
getActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()- Specified by:
getActionableDynamicQueryin interfaceSubscriptionLocalService
-
getIndexableActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()- Specified by:
getIndexableActionableDynamicQueryin interfaceSubscriptionLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifierin interfaceSubscriptionLocalService- Returns:
- the OSGi service identifier
-
getPersistedModel
public com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
getPersistedModelin interfaceSubscriptionLocalService- Throws:
PortalExceptioncom.liferay.portal.kernel.exception.PortalException
-
getSubscription
public Subscription getSubscription(long subscriptionId) throws com.liferay.portal.kernel.exception.PortalException Returns the subscription with the primary key.- Specified by:
getSubscriptionin interfaceSubscriptionLocalService- Parameters:
subscriptionId- the primary key of the subscription- Returns:
- the subscription
- Throws:
PortalException- if a subscription with the primary key could not be foundcom.liferay.portal.kernel.exception.PortalException
-
getSubscription
public Subscription getSubscription(long companyId, long userId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Returns the subscription of the user to the entity.- Specified by:
getSubscriptionin interfaceSubscriptionLocalService- Parameters:
companyId- the primary key of the companyuserId- the primary key of the userclassName- the entity's class nameclassPK- the primary key of the entity's instance- Returns:
- the subscription of the user to the entity
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getSubscriptions
Returns a range of all the subscriptions.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.subscription.model.impl.SubscriptionModelImpl.- Specified by:
getSubscriptionsin interfaceSubscriptionLocalService- Parameters:
start- the lower bound of the range of subscriptionsend- 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:
getSubscriptionsin interfaceSubscriptionLocalService- Parameters:
companyId- the primary key of the companyuserId- the primary key of the userclassName- the entity's class nameclassPKs- the primary key of the entities- Returns:
- the subscriptions of the user to the entities
-
getSubscriptions
Returns all the subscriptions to the entity.- Specified by:
getSubscriptionsin interfaceSubscriptionLocalService- Parameters:
companyId- the primary key of the companyclassName- the entity's class nameclassPK- the primary key of the entity's instance- Returns:
- the subscriptions to the entity
-
getSubscriptions
Deprecated.As of Athanasius (7.3.x), with no direct replacement- Specified by:
getSubscriptionsin interfaceSubscriptionLocalService- Parameters:
className- the entity's class name- Returns:
- the subscriptions to the class name
-
getSubscriptionsCount
public int getSubscriptionsCount()Returns the number of subscriptions.- Specified by:
getSubscriptionsCountin interfaceSubscriptionLocalService- Returns:
- the number of subscriptions
-
getSubscriptionsCount
Deprecated.As of Athanasius (7.3.x), with no direct replacement- Specified by:
getSubscriptionsCountin interfaceSubscriptionLocalService- Parameters:
className- the entity's class name- Returns:
- the subscriptions to the class name
-
getUserSubscriptions
public List<Subscription> getUserSubscriptions(long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Subscription> orderByComparator) Returns an ordered range of all the subscriptions of the user.- Specified by:
getUserSubscriptionsin interfaceSubscriptionLocalService- Parameters:
userId- the primary key of the userstart- the lower bound of the range of resultsend- 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
Returns all the subscriptions of the user to the entities with the class name.- Specified by:
getUserSubscriptionsin interfaceSubscriptionLocalService- Parameters:
userId- the primary key of the userclassName- 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:
getUserSubscriptionsCountin interfaceSubscriptionLocalService- Parameters:
userId- the primary key of the user- Returns:
- the number of subscriptions of the user
-
isSubscribed
Returnstrueif the user is subscribed to the entity.- Specified by:
isSubscribedin interfaceSubscriptionLocalService- Parameters:
companyId- the primary key of the companyuserId- the primary key of the userclassName- the entity's class nameclassPK- the primary key of the entity's instance- Returns:
trueif the user is subscribed to the entity;falseotherwise
-
isSubscribed
Returnstrueif the user is subscribed to any of the entities.- Specified by:
isSubscribedin interfaceSubscriptionLocalService- Parameters:
companyId- the primary key of the companyuserId- the primary key of the userclassName- the entity's class nameclassPKs- the primary key of the entities- Returns:
trueif the user is subscribed to any of the entities;falseotherwise
-
updateSubscription
Updates the subscription in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect SubscriptionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
updateSubscriptionin interfaceSubscriptionLocalService- Parameters:
subscription- the subscription- Returns:
- the subscription that was updated
-
updateSubscriptions
public void updateSubscriptions(long companyId, long classNameId, long oldClassPK, long newClassPK) - Specified by:
updateSubscriptionsin interfaceSubscriptionLocalService
-
getBasePersistence
public com.liferay.portal.kernel.service.persistence.BasePersistence<?> getBasePersistence()- Specified by:
getBasePersistencein interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
getCTPersistence
public com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<Subscription> getCTPersistence()- Specified by:
getCTPersistencein interfacecom.liferay.portal.kernel.service.change.tracking.CTService<Subscription>- Specified by:
getCTPersistencein interfaceSubscriptionLocalService
-
getModelClass
- Specified by:
getModelClassin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<Subscription>- Specified by:
getModelClassin interfaceSubscriptionLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<Subscription>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<Subscription>- Specified by:
updateWithUnsafeFunctionin interfaceSubscriptionLocalService- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedServicein interfacecom.liferay.portal.kernel.service.ServiceWrapper<SubscriptionLocalService>
-
setWrappedService
- Specified by:
setWrappedServicein interfacecom.liferay.portal.kernel.service.ServiceWrapper<SubscriptionLocalService>
-