|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface SubscriptionLocalService
The interface for the subscription local service.
Never modify or reference this interface directly. Always use SubscriptionLocalServiceUtil
to access the subscription local service. Add custom service methods to SubscriptionLocalServiceImpl
and rerun ServiceBuilder to automatically copy the method declarations to this interface.
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.
SubscriptionLocalServiceUtil
,
SubscriptionLocalServiceBaseImpl
,
SubscriptionLocalServiceImpl
Method Summary | |
---|---|
Subscription |
addSubscription(long userId,
String className,
long classPK)
|
Subscription |
addSubscription(long userId,
String className,
long classPK,
String frequency)
|
Subscription |
addSubscription(Subscription subscription)
Adds the subscription to the database. |
Subscription |
createSubscription(long subscriptionId)
Creates a new subscription with the primary key. |
void |
deleteSubscription(long subscriptionId)
Deletes the subscription with the primary key from the database. |
void |
deleteSubscription(long userId,
String className,
long classPK)
|
void |
deleteSubscription(Subscription subscription)
Deletes the subscription from the database. |
void |
deleteSubscriptions(long userId)
|
void |
deleteSubscriptions(long companyId,
String className,
long classPK)
|
List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
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. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Counts the number of rows that match the dynamic query. |
Subscription |
getSubscription(long subscriptionId)
Gets the subscription with the primary key. |
Subscription |
getSubscription(long companyId,
long userId,
String className,
long classPK)
|
List<Subscription> |
getSubscriptions(int start,
int end)
Gets a range of all the subscriptions. |
List<Subscription> |
getSubscriptions(long companyId,
String className,
long classPK)
|
int |
getSubscriptionsCount()
Gets the number of subscriptions. |
List<Subscription> |
getUserSubscriptions(long userId,
String className)
|
boolean |
isSubscribed(long companyId,
long userId,
String className,
long classPK)
|
Subscription |
updateSubscription(Subscription subscription)
Updates the subscription in the database. |
Subscription |
updateSubscription(Subscription subscription,
boolean merge)
Updates the subscription in the database. |
Method Detail |
---|
Subscription addSubscription(Subscription subscription) throws SystemException
subscription
- the subscription to add
SystemException
- if a system exception occurredSubscription createSubscription(long subscriptionId)
subscriptionId
- the primary key for the new subscription
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 occurredvoid deleteSubscription(Subscription subscription) throws SystemException
subscription
- the subscription to delete
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredList 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 occurredList 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 occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getSubscriptionsCount() throws SystemException
SystemException
- if a system exception occurredSubscription updateSubscription(Subscription subscription) throws SystemException
subscription
- the subscription to update
SystemException
- if a system exception occurredSubscription 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 occurredSubscription addSubscription(long userId, String className, long classPK) throws PortalException, SystemException
PortalException
SystemException
Subscription addSubscription(long userId, String className, long classPK, String frequency) throws PortalException, SystemException
PortalException
SystemException
void deleteSubscription(long userId, String className, long classPK) throws PortalException, SystemException
PortalException
SystemException
void deleteSubscriptions(long userId) throws SystemException
SystemException
void deleteSubscriptions(long companyId, String className, long classPK) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Subscription getSubscription(long companyId, long userId, String className, long classPK) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getSubscriptions(long companyId, String className, long classPK) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getUserSubscriptions(long userId, String className) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean isSubscribed(long companyId, long userId, String className, long classPK) throws SystemException
SystemException
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |