Interface SubscriptionLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
SubscriptionLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddSubscription
(long userId, long groupId, String className, long classPK) Deprecated.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) Deprecated.Subscribes the user to the entity, notifying him at the given frequency.addSubscription
(Subscription subscription) Deprecated.Adds the subscription to the database.createPersistedModel
(Serializable primaryKeyObj) Deprecated.createSubscription
(long subscriptionId) Deprecated.Creates a new subscription with the primary key.deletePersistedModel
(PersistedModel persistedModel) Deprecated.deleteSubscription
(long subscriptionId) Deprecated.Deletes the subscription with the primary key from the database.void
deleteSubscription
(long userId, String className, long classPK) Deprecated.Deletes the user's subscription to the entity.deleteSubscription
(Subscription subscription) Deprecated.Deletes the subscription from the database.void
deleteSubscriptions
(long userId) Deprecated.Deletes all the subscriptions of the user.void
deleteSubscriptions
(long userId, long groupId) Deprecated.void
deleteSubscriptions
(long companyId, String className, long classPK) Deprecated.Deletes all the subscriptions to the entity.<T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) Deprecated.int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) Deprecated.Deprecated.<T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Deprecated.Performs a dynamic query on the database and returns the matching rows.<T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end) Deprecated.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) Deprecated.Performs a dynamic query on the database and returns an ordered range of the matching rows.long
dynamicQueryCount
(DynamicQuery dynamicQuery) Deprecated.Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Deprecated.Returns the number of rows matching the dynamic query.fetchSubscription
(long subscriptionId) Deprecated.fetchSubscription
(long companyId, long userId, String className, long classPK) Deprecated.Deprecated.Deprecated.Deprecated.Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) Deprecated.getSubscription
(long subscriptionId) Deprecated.Returns the subscription with the primary key.getSubscription
(long companyId, long userId, String className, long classPK) Deprecated.Returns the subscription of the user to the entity.getSubscriptions
(int start, int end) Deprecated.Returns a range of all the subscriptions.getSubscriptions
(long companyId, long userId, String className, long[] classPKs) Deprecated.Returns all the subscriptions of the user to the entities.getSubscriptions
(long companyId, String className, long classPK) Deprecated.Returns all the subscriptions to the entity.int
Deprecated.Returns the number of subscriptions.getUserSubscriptions
(long userId, int start, int end, OrderByComparator<Subscription> orderByComparator) Deprecated.Returns an ordered range of all the subscriptions of the user.getUserSubscriptions
(long userId, String className) Deprecated.Returns all the subscriptions of the user to the entities with the class name.int
getUserSubscriptionsCount
(long userId) Deprecated.Returns the number of subscriptions of the user.boolean
isSubscribed
(long companyId, long userId, String className, long classPK) Deprecated.Returnstrue
if the user is subscribed to the entity.boolean
isSubscribed
(long companyId, long userId, String className, long[] classPKs) Deprecated.Returnstrue
if the user is subscribed to any of the entities.updateSubscription
(Subscription subscription) Deprecated.Updates the subscription in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addSubscription
Subscription addSubscription(long userId, long groupId, String className, long classPK) throws PortalException Deprecated.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.
- 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:
PortalException
-
addSubscription
Subscription addSubscription(long userId, long groupId, String className, long classPK, String frequency) throws PortalException Deprecated.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.
- 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:
PortalException
-
addSubscription
Deprecated.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.
- Parameters:
subscription
- the subscription- Returns:
- the subscription that was added
-
createPersistedModel
Deprecated.- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createSubscription
Deprecated.Creates a new subscription with the primary key. Does not add the subscription to the database.- Parameters:
subscriptionId
- the primary key for the new subscription- Returns:
- the new subscription
-
deletePersistedModel
Deprecated.- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteSubscription
Deprecated.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.
- 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
Deprecated.Deletes the user's subscription to the entity. A social activity with the unsubscribe action is created.- Parameters:
userId
- the primary key of the userclassName
- the entity's class nameclassPK
- the primary key of the entity's instance- Throws:
PortalException
-
deleteSubscription
@Indexable(type=DELETE) Subscription deleteSubscription(Subscription subscription) throws PortalException Deprecated.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.
- Parameters:
subscription
- the subscription- Returns:
- the subscription that was removed
- Throws:
PortalException
-
deleteSubscriptions
Deprecated.Deletes all the subscriptions of the user.- Parameters:
userId
- the primary key of the user- Throws:
PortalException
-
deleteSubscriptions
Deprecated.- Throws:
PortalException
-
deleteSubscriptions
Deprecated.Deletes all the subscriptions to the entity.- Parameters:
companyId
- the primary key of the companyclassName
- the entity's class nameclassPK
- the primary key of the entity's instance- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) Deprecated.- Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) Deprecated.- Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
Deprecated. -
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) Deprecated.Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Deprecated.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.SubscriptionModelImpl
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Deprecated.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.SubscriptionModelImpl
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery) Deprecated.Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Deprecated.Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchSubscription
@Transactional(propagation=SUPPORTS, readOnly=true) Subscription fetchSubscription(long subscriptionId) Deprecated. -
fetchSubscription
@Transactional(propagation=SUPPORTS, readOnly=true) Subscription fetchSubscription(long companyId, long userId, String className, long classPK) Deprecated. -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery()Deprecated. -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()Deprecated. -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Deprecated.Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException Deprecated.- Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
getSubscription
@Transactional(propagation=SUPPORTS, readOnly=true) Subscription getSubscription(long subscriptionId) throws PortalException Deprecated.Returns the subscription with the primary key.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) Subscription getSubscription(long companyId, long userId, String className, long classPK) throws PortalException Deprecated.Returns the subscription of the user to the entity.- 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:
PortalException
-
getSubscriptions
@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getSubscriptions(int start, int end) Deprecated.Returns a range of all the subscriptions.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.SubscriptionModelImpl
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getSubscriptions(long companyId, long userId, String className, long[] classPKs) Deprecated.Returns all the subscriptions of the user to the entities.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getSubscriptions(long companyId, String className, long classPK) Deprecated.Returns all the subscriptions to the entity.- 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
-
getSubscriptionsCount
Deprecated.Returns the number of subscriptions.- Returns:
- the number of subscriptions
-
getUserSubscriptions
@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getUserSubscriptions(long userId, int start, int end, OrderByComparator<Subscription> orderByComparator) Deprecated.Returns an ordered range of all the subscriptions of the user.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getUserSubscriptions(long userId, String className) Deprecated.Returns all the subscriptions of the user to the entities with the class name.- 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
Deprecated.Returns the number of subscriptions of the user.- Parameters:
userId
- the primary key of the user- Returns:
- the number of subscriptions of the user
-
isSubscribed
@Transactional(propagation=SUPPORTS, readOnly=true) boolean isSubscribed(long companyId, long userId, String className, long classPK) Deprecated.Returnstrue
if the user is subscribed to the entity.- 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:
true
if the user is subscribed to the entity;false
otherwise
-
isSubscribed
@Transactional(propagation=SUPPORTS, readOnly=true) boolean isSubscribed(long companyId, long userId, String className, long[] classPKs) Deprecated.Returnstrue
if the user is subscribed to any of the entities.- 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:
true
if the user is subscribed to any of the entities;false
otherwise
-
updateSubscription
Deprecated.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.
- Parameters:
subscription
- the subscription- Returns:
- the subscription that was updated
-
com.liferay.subscription.service.impl.SubscriptionLocalServiceImpl