|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.SubscriptionLocalServiceUtil
public class SubscriptionLocalServiceUtil
The utility for the subscription local service. This utility wraps SubscriptionLocalServiceImpl
and is the primary access point for service operations in application layer code running on the local server.
Never modify this class directly. Add custom service methods to SubscriptionLocalServiceImpl
and rerun ServiceBuilder to regenerate this class.
This is a local service. 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
,
SubscriptionLocalServiceImpl
Constructor Summary | |
---|---|
SubscriptionLocalServiceUtil()
|
Method Summary | |
---|---|
static Subscription |
addSubscription(long userId,
String className,
long classPK)
|
static Subscription |
addSubscription(long userId,
String className,
long classPK,
String 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 void |
deleteSubscription(long subscriptionId)
Deletes the subscription with the primary key from the database. |
static void |
deleteSubscription(long userId,
String className,
long classPK)
|
static void |
deleteSubscription(Subscription subscription)
Deletes the subscription from the database. |
static void |
deleteSubscriptions(long userId)
|
static void |
deleteSubscriptions(long companyId,
String className,
long classPK)
|
static List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Counts the number of rows that match the dynamic query. |
static SubscriptionLocalService |
getService()
|
static Subscription |
getSubscription(long subscriptionId)
Gets the subscription with the primary key. |
static Subscription |
getSubscription(long companyId,
long userId,
String className,
long classPK)
|
static List<Subscription> |
getSubscriptions(int start,
int end)
Gets a range of all the subscriptions. |
static List<Subscription> |
getSubscriptions(long companyId,
String className,
long classPK)
|
static int |
getSubscriptionsCount()
Gets the number of subscriptions. |
static List<Subscription> |
getUserSubscriptions(long userId,
String className)
|
static boolean |
isSubscribed(long companyId,
long userId,
String className,
long classPK)
|
void |
setService(SubscriptionLocalService service)
|
static Subscription |
updateSubscription(Subscription subscription)
Updates the subscription in the database. |
static Subscription |
updateSubscription(Subscription subscription,
boolean merge)
Updates the subscription in the database. |
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) throws SystemException
subscription
- the subscription to add
SystemException
- if a system exception occurredpublic static Subscription createSubscription(long subscriptionId)
subscriptionId
- the primary key for the new subscription
public static void deleteSubscription(long subscriptionId) throws PortalException, SystemException
subscriptionId
- the primary key of the subscription to delete
PortalException
- if a subscription with the primary key could not be found
SystemException
- if a system exception occurredpublic static void deleteSubscription(Subscription subscription) throws SystemException
subscription
- the subscription to delete
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)orderByComparator
- the comparator to order the results by
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static Subscription getSubscription(long subscriptionId) throws PortalException, SystemException
subscriptionId
- the primary key of the subscription to get
PortalException
- if a subscription with the primary key could not be found
SystemException
- if a system exception occurredpublic static List<Subscription> getSubscriptions(int start, int end) throws SystemException
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.
start
- the lower bound of the range of subscriptions to returnend
- the upper bound of the range of subscriptions to return (not inclusive)
SystemException
- if a system exception occurredpublic static int getSubscriptionsCount() throws SystemException
SystemException
- if a system exception occurredpublic static Subscription updateSubscription(Subscription subscription) throws SystemException
subscription
- the subscription to update
SystemException
- if a system exception occurredpublic static Subscription updateSubscription(Subscription subscription, boolean merge) throws SystemException
subscription
- the subscription to updatemerge
- whether to merge the subscription with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)
for an explanation.
SystemException
- if a system exception occurredpublic static Subscription addSubscription(long userId, String className, long classPK) throws PortalException, SystemException
PortalException
SystemException
public static Subscription addSubscription(long userId, String className, long classPK, String frequency) throws PortalException, SystemException
PortalException
SystemException
public static void deleteSubscription(long userId, String className, long classPK) throws PortalException, SystemException
PortalException
SystemException
public static void deleteSubscriptions(long userId) throws SystemException
SystemException
public static void deleteSubscriptions(long companyId, String className, long classPK) throws SystemException
SystemException
public static Subscription getSubscription(long companyId, long userId, String className, long classPK) throws PortalException, SystemException
PortalException
SystemException
public static List<Subscription> getSubscriptions(long companyId, String className, long classPK) throws SystemException
SystemException
public static List<Subscription> getUserSubscriptions(long userId, String className) throws SystemException
SystemException
public static boolean isSubscribed(long companyId, long userId, String className, long classPK) throws SystemException
SystemException
public static SubscriptionLocalService getService()
public void setService(SubscriptionLocalService service)
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |