com.atlassian.jira.issue.subscription
Interface SubscriptionManager

All Known Implementing Classes:

DefaultSubscriptionManager

public interface SubscriptionManager

Method Summary

org.ofbiz.core.entity.GenericValue	createSubscription(User user, Long filterId, String groupName, Long period, Boolean emailOnEmpty)
org.ofbiz.core.entity.GenericValue	createSubscription(User user, Long filterId, String groupName, org.quartz.Trigger trigger, Boolean emailOnEmpty) Creates a new subscription based on the passed in filter id and fired in accordance with the passed in trigger
void	deleteSubscription(Long subId)
void	deleteSubscriptionsForUser(User user)
List	getAllSubscriptions()
List	getAllSubscriptions(Long filterId)
org.ofbiz.core.entity.GenericValue	getSubscription(User user, Long subId)
org.ofbiz.core.entity.GenericValue	getSubscriptionFromTriggerName(String triggerName)
List	getSubscriptions(User user, Long filterId)
org.quartz.Trigger	getTriggerFromSubscription(org.ofbiz.core.entity.GenericValue subscription)
boolean	hasSubscription(User user, Long filterId)
void	runSubscription(org.ofbiz.core.entity.GenericValue subId)
void	runSubscription(User u, Long subId)
void	updateSubscription(User user, Long subscriptionId, Map fields, org.quartz.Trigger trigger) Deprecated. Should use the method with an explicit list of fields
void	updateSubscription(User user, Long subscriptionId, String groupName, org.quartz.Trigger trigger, Boolean emailOnEmpty)

Method Detail

hasSubscription

boolean hasSubscription(User user,
                        Long filterId)
                        throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getSubscription

org.ofbiz.core.entity.GenericValue getSubscription(User user,
                                                   Long subId)
                                                   throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getSubscriptions

List getSubscriptions(User user,
                      Long filterId)
                      throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

createSubscription

org.ofbiz.core.entity.GenericValue createSubscription(User user,
                                                      Long filterId,
                                                      String groupName,
                                                      Long period,
                                                      Boolean emailOnEmpty)

createSubscription

org.ofbiz.core.entity.GenericValue createSubscription(User user,
                                                      Long filterId,
                                                      String groupName,
                                                      org.quartz.Trigger trigger,
                                                      Boolean emailOnEmpty)

Creates a new subscription based on the passed in filter id and fired in accordance with the passed in trigger

Parameters:

user - the current user performing this operation

filterId - Id of the filter subscribing to

groupName - Sent ot group

trigger - The trigger to store

emailOnEmpty - send email if filter returns no results

Returns:

GenericValue representing new subscription

Throws:

Exception

deleteSubscription

void deleteSubscription(Long subId)
                        throws Exception

Throws:

Exception

runSubscription

void runSubscription(org.ofbiz.core.entity.GenericValue subId)
                     throws Exception

Throws:

Exception

runSubscription

void runSubscription(User u,
                     Long subId)
                     throws Exception

Throws:

Exception

getSubscriptionFromTriggerName

org.ofbiz.core.entity.GenericValue getSubscriptionFromTriggerName(String triggerName)
                                                                  throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getTriggerFromSubscription

org.quartz.Trigger getTriggerFromSubscription(org.ofbiz.core.entity.GenericValue subscription)
                                              throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

updateSubscription

void updateSubscription(User user,
                        Long subscriptionId,
                        Map fields,
                        org.quartz.Trigger trigger)
                        throws DataAccessException

Deprecated. Should use the method with an explicit list of fields

This will update the subscription identified by the subscription id to contain the details specifed in the fields map and it will update the trigger with the provided the Trigger.

Parameters:

user - the current user performing this operation

subscriptionId - identifies the subscription to update

fields - the fields to update the subscription with.

trigger - The trigger to update the subscription with

Throws:

DataAccessException - if there is a problem persisting the data.

updateSubscription

void updateSubscription(User user,
                        Long subscriptionId,
                        String groupName,
                        org.quartz.Trigger trigger,
                        Boolean emailOnEmpty)
                        throws DataAccessException

Parameters:

user - the current user performing this operation

subscriptionId - identifies the subscription to update

groupName - (optional) the name of the group to receive the email

trigger - The trigger to update the subscription with

Throws:

DataAccessException - if there is a problem persisting the data.

getAllSubscriptions

List getAllSubscriptions(Long filterId)

getAllSubscriptions

List getAllSubscriptions()

deleteSubscriptionsForUser

void deleteSubscriptionsForUser(User user)
                                throws Exception

Throws:

Exception