|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface SubscriptionLocalServiceProvides the local service interface for Subscription. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
SubscriptionLocalServiceUtil,
SubscriptionLocalServiceBaseImpl,
SubscriptionLocalServiceImpl| 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. |
|
PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
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 userId,
long groupId)
|
|
void |
deleteSubscriptions(long companyId,
String className,
long classPK)
Deletes all the subscriptions to the entity. |
|
DynamicQuery |
dynamicQuery()
|
|
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> 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 matching the dynamic query. |
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
Subscription |
fetchSubscription(long subscriptionId)
|
|
Subscription |
fetchSubscription(long companyId,
long userId,
String className,
long classPK)
|
|
ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery()
|
|
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
|
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<Subscription> 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. |
|
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. |
|
Subscription |
updateSubscription(Subscription subscription)
Updates the subscription in the database or adds it if it does not yet exist. |
|
| Method Detail |
|---|
@Indexable(type=REINDEX) Subscription addSubscription(Subscription subscription)
subscription - the subscription
Subscription addSubscription(long userId,
long groupId,
String className,
long classPK)
throws 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 instance
PortalException
Subscription addSubscription(long userId,
long groupId,
String className,
long classPK,
String frequency)
throws 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 notifications
PortalExceptionSubscription createSubscription(long subscriptionId)
subscriptionId - the primary key for the new subscription
PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
deletePersistedModel in interface PersistedModelLocalServicePortalException
@Indexable(type=DELETE)
Subscription deleteSubscription(Subscription subscription)
throws PortalException
subscription - the subscription
PortalException
@Indexable(type=DELETE)
Subscription deleteSubscription(long subscriptionId)
throws PortalException
subscriptionId - the primary key of the subscription
PortalException - if a subscription with the primary key could not be found
void deleteSubscription(long userId,
String className,
long classPK)
throws PortalException
userId - the primary key of the userclassName - the entity's class nameclassPK - the primary key of the entity's instance
PortalException
void deleteSubscriptions(long companyId,
String className,
long classPK)
throws PortalException
companyId - the primary key of the companyclassName - the entity's class nameclassPK - the primary key of the entity's instance
PortalException
void deleteSubscriptions(long userId)
throws PortalException
userId - the primary key of the user
PortalException
void deleteSubscriptions(long userId,
long groupId)
throws PortalException
PortalExceptionDynamicQuery dynamicQuery()
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
<T> List<T> dynamicQuery(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 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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
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 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.
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)
long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
@Transactional(propagation=SUPPORTS,
readOnly=true)
Subscription fetchSubscription(long companyId,
long userId,
String className,
long classPK)
@Transactional(propagation=SUPPORTS,
readOnly=true)
Subscription fetchSubscription(long subscriptionId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS,
readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS,
readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
getPersistedModel in interface PersistedModelLocalServicePortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
Subscription getSubscription(long companyId,
long userId,
String className,
long classPK)
throws 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 instance
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
Subscription getSubscription(long subscriptionId)
throws PortalException
subscriptionId - the primary key of the subscription
PortalException - if a subscription with the primary key could not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Subscription> getSubscriptions(long companyId,
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)
List<Subscription> getSubscriptions(long companyId,
long userId,
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)
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 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.
start - the lower bound of the range of subscriptionsend - the upper bound of the range of subscriptions (not inclusive)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getSubscriptionsCount()
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Subscription> getUserSubscriptions(long userId,
String className)
userId - the primary key of the userclassName - the entity's class name
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Subscription> getUserSubscriptions(long userId,
int start,
int end,
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)
int getUserSubscriptionsCount(long userId)
userId - the primary key of the user
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean isSubscribed(long companyId,
long userId,
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 instance
true if the user is subscribed to the entity;
false otherwise
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean isSubscribed(long companyId,
long userId,
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 entities
true if the user is subscribed to any of the
entities; false otherwise@Indexable(type=REINDEX) Subscription updateSubscription(Subscription subscription)
subscription - the subscription
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||