@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface SubscriptionLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
SubscriptionLocalServiceUtil
Modifier and Type | Method and Description |
---|---|
Subscription |
addSubscription(long userId,
long groupId,
java.lang.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,
java.lang.String className,
long classPK,
java.lang.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.
|
void |
deleteGroupSubscriptions(long groupId) |
com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
Subscription |
deleteSubscription(long subscriptionId)
Deletes the subscription with the primary key from the database.
|
void |
deleteSubscription(long userId,
java.lang.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,
java.lang.String className,
long classPK)
Deletes all the subscriptions to the entity.
|
com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
<T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
<T> java.util.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> java.util.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.
|
long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
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.
|
Subscription |
fetchSubscription(long subscriptionId) |
Subscription |
fetchSubscription(long companyId,
long userId,
java.lang.String className,
long classPK) |
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
Subscription |
getSubscription(long subscriptionId)
Returns the subscription with the primary key.
|
Subscription |
getSubscription(long companyId,
long userId,
java.lang.String className,
long classPK)
Returns the subscription of the user to the entity.
|
java.util.List<Subscription> |
getSubscriptions(int start,
int end)
Returns a range of all the subscriptions.
|
java.util.List<Subscription> |
getSubscriptions(long companyId,
long userId,
java.lang.String className,
long[] classPKs)
Returns all the subscriptions of the user to the entities.
|
java.util.List<Subscription> |
getSubscriptions(long companyId,
java.lang.String className,
long classPK)
Returns all the subscriptions to the entity.
|
java.util.List<Subscription> |
getSubscriptions(java.lang.String className)
Returns all the subscriptions to the class name.
|
int |
getSubscriptionsCount()
Returns the number of subscriptions.
|
int |
getSubscriptionsCount(java.lang.String className)
Returns the number of the subscriptions to the class name.
|
java.util.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.
|
java.util.List<Subscription> |
getUserSubscriptions(long userId,
java.lang.String className)
Returns all the subscriptions of the user to the entities with the class
name.
|
int |
getUserSubscriptionsCount(long userId)
Returns the number of subscriptions of the user.
|
boolean |
isSubscribed(long companyId,
long userId,
java.lang.String className,
long classPK)
Returns
true if the user is subscribed to the entity. |
boolean |
isSubscribed(long companyId,
long userId,
java.lang.String className,
long[] classPKs)
Returns
true if the user is subscribed to any of the
entities. |
Subscription |
updateSubscription(Subscription subscription)
Updates the subscription in the database or adds it if it does not yet exist.
|
Subscription addSubscription(long userId, long groupId, java.lang.String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
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.
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 instancecom.liferay.portal.kernel.exception.PortalException
Subscription addSubscription(long userId, long groupId, java.lang.String className, long classPK, java.lang.String frequency) throws com.liferay.portal.kernel.exception.PortalException
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.
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 notificationscom.liferay.portal.kernel.exception.PortalException
@Indexable(type=REINDEX) Subscription addSubscription(Subscription subscription)
subscription
- the subscription@Transactional(enabled=false) Subscription createSubscription(long subscriptionId)
subscriptionId
- the primary key for the new subscriptionvoid deleteGroupSubscriptions(long groupId)
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
deletePersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=DELETE) Subscription deleteSubscription(long subscriptionId) throws com.liferay.portal.kernel.exception.PortalException
subscriptionId
- the primary key of the subscriptioncom.liferay.portal.kernel.exception.PortalException
- if a subscription with the primary key could not be foundvoid deleteSubscription(long userId, java.lang.String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the userclassName
- the entity's class nameclassPK
- the primary key of the entity's instancecom.liferay.portal.kernel.exception.PortalException
@Indexable(type=DELETE) Subscription deleteSubscription(Subscription subscription) throws com.liferay.portal.kernel.exception.PortalException
subscription
- the subscriptioncom.liferay.portal.kernel.exception.PortalException
void deleteSubscriptions(long userId) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the usercom.liferay.portal.kernel.exception.PortalException
void deleteSubscriptions(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
void deleteSubscriptions(long companyId, java.lang.String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
companyId
- the primary key of the companyclassName
- the entity's class nameclassPK
- the primary key of the entity's instancecom.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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 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, then the query will include the default ORDER BY logic from com.liferay.subscription.model.impl.SubscriptionModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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 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, then the query will include the default ORDER BY logic from com.liferay.subscription.model.impl.SubscriptionModelImpl
.
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 (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query@Transactional(propagation=SUPPORTS, readOnly=true) Subscription fetchSubscription(long subscriptionId)
@Transactional(propagation=SUPPORTS, readOnly=true) Subscription fetchSubscription(long companyId, long userId, java.lang.String className, long classPK)
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
java.lang.String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
getPersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Subscription getSubscription(long subscriptionId) throws com.liferay.portal.kernel.exception.PortalException
subscriptionId
- the primary key of the subscriptioncom.liferay.portal.kernel.exception.PortalException
- if a subscription with the primary key could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Subscription getSubscription(long companyId, long userId, java.lang.String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
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 instancecom.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Subscription> getSubscriptions(int start, int end)
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 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, then the query will include the default ORDER BY logic from com.liferay.subscription.model.impl.SubscriptionModelImpl
.
start
- the lower bound of the range of subscriptionsend
- the upper bound of the range of subscriptions (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Subscription> getSubscriptions(long companyId, long userId, java.lang.String className, long[] classPKs)
companyId
- the primary key of the companyuserId
- the primary key of the userclassName
- the entity's class nameclassPKs
- the primary key of the entities@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Subscription> getSubscriptions(long companyId, java.lang.String className, long classPK)
companyId
- the primary key of the companyclassName
- the entity's class nameclassPK
- the primary key of the entity's instance@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Subscription> getSubscriptions(java.lang.String className)
className
- the entity's class name@Transactional(propagation=SUPPORTS, readOnly=true) int getSubscriptionsCount()
@Transactional(propagation=SUPPORTS, readOnly=true) int getSubscriptionsCount(java.lang.String className)
className
- the entity's class name@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Subscription> getUserSubscriptions(long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Subscription> orderByComparator)
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@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Subscription> getUserSubscriptions(long userId, java.lang.String className)
userId
- the primary key of the userclassName
- the entity's class name@Transactional(propagation=SUPPORTS, readOnly=true) int getUserSubscriptionsCount(long userId)
userId
- the primary key of the user@Transactional(propagation=SUPPORTS, readOnly=true) boolean isSubscribed(long companyId, long userId, java.lang.String className, long classPK)
true
if the user is subscribed to the entity.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 instancetrue
if the user is subscribed to the entity;
false
otherwise@Transactional(propagation=SUPPORTS, readOnly=true) boolean isSubscribed(long companyId, long userId, java.lang.String className, long[] classPKs)
true
if the user is subscribed to any of the
entities.companyId
- the primary key of the companyuserId
- the primary key of the userclassName
- the entity's class nameclassPKs
- the primary key of the entitiestrue
if the user is subscribed to any of the
entities; false
otherwise@Indexable(type=REINDEX) Subscription updateSubscription(Subscription subscription)
subscription
- the subscription