|
Liferay 6.2-ce-ga5 | |||||||||
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 SubscriptionLocalService
Provides 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
,
com.liferay.portal.service.impl.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. |
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 companyId,
String className,
long classPK)
Deletes all the subscriptions to the entity. |
DynamicQuery |
dynamicQuery()
|
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)
Returns the number of rows that match the dynamic query. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query. |
Subscription |
fetchSubscription(long subscriptionId)
|
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
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 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. |
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
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) throws SystemException
subscription
- the subscription
SystemException
- if a system exception occurredSubscription createSubscription(long subscriptionId)
subscriptionId
- the primary key for the new subscription
@Indexable(type=DELETE) Subscription deleteSubscription(long subscriptionId) throws PortalException, SystemException
subscriptionId
- the primary key of the subscription
PortalException
- if a subscription with the primary key could not be found
SystemException
- if a system exception occurred@Indexable(type=DELETE) Subscription deleteSubscription(Subscription subscription) throws PortalException, SystemException
subscription
- the subscription
PortalException
SystemException
- if a system exception occurredDynamicQuery dynamicQuery()
List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
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. 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)
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. 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
)
SystemException
- if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Subscription fetchSubscription(long subscriptionId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Subscription getSubscription(long subscriptionId) throws PortalException, SystemException
subscriptionId
- the primary key of the subscription
PortalException
- if a subscription with the primary key could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
getPersistedModel
in interface PersistedModelLocalService
PortalException
SystemException
@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. 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)
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getSubscriptionsCount() throws SystemException
SystemException
- if a system exception occurred@Indexable(type=REINDEX) Subscription updateSubscription(Subscription subscription) throws SystemException
subscription
- the subscription
SystemException
- if a system exception occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanSubscription addSubscription(long userId, long groupId, String className, long classPK) throws PortalException, SystemException
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
- if a matching user or group could not be found
SystemException
- if a system exception occurredSubscription addSubscription(long userId, long groupId, String className, long classPK, String frequency) throws PortalException, SystemException
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
PortalException
- if a matching user or group could not be found
SystemException
- if a system exception occurredvoid deleteSubscription(long userId, String className, long classPK) throws PortalException, SystemException
userId
- the primary key of the userclassName
- the entity's class nameclassPK
- the primary key of the entity's instance
PortalException
- if a matching user or subscription could not be
found
SystemException
- if a system exception occurredvoid deleteSubscriptions(long userId) throws PortalException, SystemException
userId
- the primary key of the user
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredvoid deleteSubscriptions(long companyId, String className, long classPK) throws PortalException, SystemException
companyId
- the primary key of the companyclassName
- the entity's class nameclassPK
- the primary key of the entity's instance
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Subscription getSubscription(long companyId, long userId, String className, long classPK) throws PortalException, SystemException
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
- if a matching subscription could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getSubscriptions(long companyId, long userId, String className, long[] classPKs) throws SystemException
companyId
- the primary key of the companyuserId
- the primary key of the userclassName
- the entity's class nameclassPKs
- the primary key of the entities
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getSubscriptions(long companyId, String className, long classPK) throws SystemException
companyId
- the primary key of the companyclassName
- the entity's class nameclassPK
- the primary key of the entity's instance
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getUserSubscriptions(long userId, int start, int end, OrderByComparator orderByComparator) throws SystemException
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
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getUserSubscriptions(long userId, String className) throws SystemException
userId
- the primary key of the userclassName
- the entity's class name
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getUserSubscriptionsCount(long userId) throws SystemException
userId
- the primary key of the user
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean isSubscribed(long companyId, long userId, String className, long classPK) throws SystemException
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
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean isSubscribed(long companyId, long userId, String className, long[] classPKs) throws SystemException
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
SystemException
- if a system exception occurred
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |