|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.SubscriptionLocalServiceUtil
@ProviderType public class SubscriptionLocalServiceUtil
Provides the local service utility for Subscription. This utility wraps
com.liferay.portal.service.impl.SubscriptionLocalServiceImpl and is the
primary access point for service operations in application layer code running
on the local server. 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.
SubscriptionLocalService,
SubscriptionLocalServiceBaseImpl,
com.liferay.portal.service.impl.SubscriptionLocalServiceImpl| Constructor Summary | |
|---|---|
SubscriptionLocalServiceUtil()
|
|
| Method Summary | ||
|---|---|---|
static 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. |
|
static Subscription |
addSubscription(long userId,
long groupId,
String className,
long classPK,
String frequency)
Subscribes the user to the entity, notifying him at the given frequency. |
|
static Subscription |
addSubscription(Subscription subscription)
Adds the subscription to the database. |
|
static Subscription |
createSubscription(long subscriptionId)
Creates a new subscription with the primary key. |
|
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
static Subscription |
deleteSubscription(long subscriptionId)
Deletes the subscription with the primary key from the database. |
|
static void |
deleteSubscription(long userId,
String className,
long classPK)
Deletes the user's subscription to the entity. |
|
static Subscription |
deleteSubscription(Subscription subscription)
Deletes the subscription from the database. |
|
static void |
deleteSubscriptions(long userId)
Deletes all the subscriptions of the user. |
|
static void |
deleteSubscriptions(long userId,
long groupId)
|
|
static void |
deleteSubscriptions(long companyId,
String className,
long classPK)
Deletes all the subscriptions to the entity. |
|
static DynamicQuery |
dynamicQuery()
|
|
static
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
static
|
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. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
static Subscription |
fetchSubscription(long subscriptionId)
|
|
static Subscription |
fetchSubscription(long companyId,
long userId,
String className,
long classPK)
|
|
static ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery()
|
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
static SubscriptionLocalService |
getService()
|
|
static Subscription |
getSubscription(long subscriptionId)
Returns the subscription with the primary key. |
|
static Subscription |
getSubscription(long companyId,
long userId,
String className,
long classPK)
Returns the subscription of the user to the entity. |
|
static List<Subscription> |
getSubscriptions(int start,
int end)
Returns a range of all the subscriptions. |
|
static List<Subscription> |
getSubscriptions(long companyId,
long userId,
String className,
long[] classPKs)
Returns all the subscriptions of the user to the entities. |
|
static List<Subscription> |
getSubscriptions(long companyId,
String className,
long classPK)
Returns all the subscriptions to the entity. |
|
static int |
getSubscriptionsCount()
Returns the number of subscriptions. |
|
static List<Subscription> |
getUserSubscriptions(long userId,
int start,
int end,
OrderByComparator<Subscription> orderByComparator)
Returns an ordered range of all the subscriptions of the user. |
|
static List<Subscription> |
getUserSubscriptions(long userId,
String className)
Returns all the subscriptions of the user to the entities with the class name. |
|
static int |
getUserSubscriptionsCount(long userId)
Returns the number of subscriptions of the user. |
|
static boolean |
isSubscribed(long companyId,
long userId,
String className,
long classPK)
Returns true if the user is subscribed to the entity. |
|
static boolean |
isSubscribed(long companyId,
long userId,
String className,
long[] classPKs)
Returns true if the user is subscribed to any of the
entities. |
|
static Subscription |
updateSubscription(Subscription subscription)
Updates the subscription in the database or adds it if it does not yet exist. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SubscriptionLocalServiceUtil()
| Method Detail |
|---|
public static Subscription addSubscription(Subscription subscription)
subscription - the subscription
public static 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
public static 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
PortalExceptionpublic static Subscription createSubscription(long subscriptionId)
subscriptionId - the primary key for the new subscription
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
PortalException
public static Subscription deleteSubscription(Subscription subscription)
throws PortalException
subscription - the subscription
PortalException
public static 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
public static 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
public static 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
public static void deleteSubscriptions(long userId)
throws PortalException
userId - the primary key of the user
PortalException
public static void deleteSubscriptions(long userId,
long groupId)
throws PortalException
PortalExceptionpublic static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static <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)
public static <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)
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
public static Subscription fetchSubscription(long companyId,
long userId,
String className,
long classPK)
public static Subscription fetchSubscription(long subscriptionId)
public static ActionableDynamicQuery getActionableDynamicQuery()
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
PortalException
public static 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
public static 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
public static 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
public static 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
public static 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)
public static int getSubscriptionsCount()
public static List<Subscription> getUserSubscriptions(long userId,
String className)
userId - the primary key of the userclassName - the entity's class name
public static 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
public static int getUserSubscriptionsCount(long userId)
userId - the primary key of the user
public static 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
public static 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 otherwisepublic static Subscription updateSubscription(Subscription subscription)
subscription - the subscription
public static SubscriptionLocalService getService()
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||