com.atlassian.jira.issue.subscription

Interface SubscriptionManager

All Known Implementing Classes:

DefaultSubscriptionManager

@PublicApi
public interface SubscriptionManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUBSCRIPTION_IDENTIFIER

Method Summary

Methods

Modifier and Type	Method and Description
org.ofbiz.core.entity.GenericValue	createSubscription(ApplicationUser user, Long filterId, String groupName, Long period, Boolean emailOnEmpty)
FilterSubscription	createSubscription(ApplicationUser user, Long filterId, String groupName, String cronExpression, Boolean emailOnEmpty) Creates a new subscription based on the passed in filter id and fired in accordance with the passed in trigger
org.ofbiz.core.entity.GenericValue	createSubscription(ApplicationUser user, Long filterId, String groupName, org.quartz.Trigger trigger, Boolean emailOnEmpty) Deprecated. Since v6.2. Quartz internals are no longer supported through the JIRA api use createSubscription(ApplicationUser, Long, String, String, Boolean)
org.ofbiz.core.entity.GenericValue	createSubscription(com.atlassian.crowd.embedded.api.User user, Long filterId, String groupName, Long period, Boolean emailOnEmpty) Deprecated. Use createSubscription(com.atlassian.jira.user.ApplicationUser, Long, String, org.quartz.Trigger, Boolean) instead. Since v6.0.
org.ofbiz.core.entity.GenericValue	createSubscription(com.atlassian.crowd.embedded.api.User user, Long filterId, String groupName, org.quartz.Trigger trigger, Boolean emailOnEmpty) Deprecated. Use createSubscription(ApplicationUser, Long, String, String, Boolean) instead. Since v6.0. 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	deleteSubscriptionsForGroup(com.atlassian.crowd.embedded.api.Group group)
void	deleteSubscriptionsForUser(ApplicationUser user)
void	deleteSubscriptionsForUser(com.atlassian.crowd.embedded.api.User user) Deprecated. Use deleteSubscriptionsForUser(ApplicationUser) instead. Since v6.0.
List<FilterSubscription>	getAllFilterSubscriptions()
List<FilterSubscription>	getAllFilterSubscriptions(Long filterId)
List<org.ofbiz.core.entity.GenericValue>	getAllSubscriptions() Deprecated. Use use getAllFilterSubscriptions() instead. Since v6.2.
List<org.ofbiz.core.entity.GenericValue>	getAllSubscriptions(Long filterId) Deprecated. Use use getAllFilterSubscriptions(Long filterId) instead. Since v6.2.
String	getCronExpressionForSubscription(FilterSubscription subscription) Retrieve the cron expression associated with this subscription
FilterSubscription	getFilterSubscription(ApplicationUser user, Long subId)
FilterSubscription	getFilterSubscription(Long subId) Get a subscription by Id
List<FilterSubscription>	getFilterSubscriptions(ApplicationUser user, Long filterId)
Date	getNextSendTime(FilterSubscription sub) Returns the next send time for this subscription.
org.ofbiz.core.entity.GenericValue	getSubscription(ApplicationUser user, Long subId) Deprecated. Use getFilterSubscription(ApplicationUser, Long) instead. Since v6.0.
org.ofbiz.core.entity.GenericValue	getSubscription(com.atlassian.crowd.embedded.api.User user, Long subId) Deprecated. Use getFilterSubscription(ApplicationUser, Long) instead. Since v6.0.
org.ofbiz.core.entity.GenericValue	getSubscriptionFromTriggerName(String triggerName) Deprecated. Since v6.2. Quartz internals are no longer supported through the JIRA api. Use getFilterSubscription(Long) instead
List<org.ofbiz.core.entity.GenericValue>	getSubscriptions(ApplicationUser user, Long filterId) Deprecated. Use getFilterSubscriptions(ApplicationUser, Long) instead. Since v6.0.
List<org.ofbiz.core.entity.GenericValue>	getSubscriptions(com.atlassian.crowd.embedded.api.User user, Long filterId) Deprecated. Use getFilterSubscriptions(ApplicationUser, Long) instead. Since v6.0.
org.quartz.Trigger	getTriggerFromSubscription(org.ofbiz.core.entity.GenericValue subscription) Deprecated. Since v6.2. Quartz internals are no longer supported through the JIRA api
boolean	hasSubscription(ApplicationUser user, Long filterId)
boolean	hasSubscription(com.atlassian.crowd.embedded.api.User user, Long filterId) Deprecated. Use hasSubscription(ApplicationUser, Long) instead. Since v6.0.
void	runSubscription(ApplicationUser user, Long subId)
void	runSubscription(org.ofbiz.core.entity.GenericValue subId) Deprecated. Use runSubscription(Long). Since v6.2
void	runSubscription(Long subId)
void	runSubscription(com.atlassian.crowd.embedded.api.User user, Long subId) Deprecated. Use runSubscription(com.atlassian.jira.user.ApplicationUser, Long) instead. Since v6.0.
void	updateSubscription(ApplicationUser user, Long subscriptionId, String groupName, String cronExpression, Boolean emailOnEmpty)
void	updateSubscription(ApplicationUser user, Long subscriptionId, String groupName, org.quartz.Trigger trigger, Boolean emailOnEmpty) Deprecated. Since v6.2. Quartz internals are no longer supported through the JIRA api use updateSubscription(ApplicationUser, Long, String, String, Boolean)
void	updateSubscription(com.atlassian.crowd.embedded.api.User user, Long subscriptionId, String groupName, org.quartz.Trigger trigger, Boolean emailOnEmpty) Deprecated. Use use updateSubscription(ApplicationUser, Long, String, String, Boolean) instead. Since v6.0.

Field Detail

SUBSCRIPTION_IDENTIFIER

static final String SUBSCRIPTION_IDENTIFIER

See Also:

Constant Field Values

Method Detail

hasSubscription

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

Throws:

org.ofbiz.core.entity.GenericEntityException

hasSubscription

boolean hasSubscription(com.atlassian.crowd.embedded.api.User user,
                      Long filterId)
                        throws org.ofbiz.core.entity.GenericEntityException

Deprecated. Use hasSubscription(ApplicationUser, Long) instead. Since v6.0.

Throws:

org.ofbiz.core.entity.GenericEntityException

getFilterSubscription

FilterSubscription getFilterSubscription(ApplicationUser user,
                                       Long subId)
                                         throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getSubscription

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

Deprecated. Use getFilterSubscription(ApplicationUser, Long) instead. Since v6.0.

Throws:

org.ofbiz.core.entity.GenericEntityException

getSubscription

org.ofbiz.core.entity.GenericValue getSubscription(com.atlassian.crowd.embedded.api.User user,
                                                 Long subId)
                                                   throws org.ofbiz.core.entity.GenericEntityException

Deprecated. Use getFilterSubscription(ApplicationUser, Long) instead. Since v6.0.

Throws:

org.ofbiz.core.entity.GenericEntityException

getFilterSubscriptions

List<FilterSubscription> getFilterSubscriptions(ApplicationUser user,
                                              Long filterId)
                                                throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getSubscriptions

List<org.ofbiz.core.entity.GenericValue> getSubscriptions(ApplicationUser user,
                                                        Long filterId)
                                                          throws org.ofbiz.core.entity.GenericEntityException

Deprecated. Use getFilterSubscriptions(ApplicationUser, Long) instead. Since v6.0.

Throws:

org.ofbiz.core.entity.GenericEntityException

getSubscriptions

List<org.ofbiz.core.entity.GenericValue> getSubscriptions(com.atlassian.crowd.embedded.api.User user,
                                                        Long filterId)
                                                          throws org.ofbiz.core.entity.GenericEntityException

Deprecated. Use getFilterSubscriptions(ApplicationUser, Long) instead. Since v6.0.

Throws:

org.ofbiz.core.entity.GenericEntityException

createSubscription

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

createSubscription

org.ofbiz.core.entity.GenericValue createSubscription(com.atlassian.crowd.embedded.api.User user,
                                                    Long filterId,
                                                    String groupName,
                                                    Long period,
                                                    Boolean emailOnEmpty)

Deprecated. Use createSubscription(com.atlassian.jira.user.ApplicationUser, Long, String, org.quartz.Trigger, Boolean) instead. Since v6.0.

createSubscription

FilterSubscription createSubscription(ApplicationUser user,
                                    Long filterId,
                                    String groupName,
                                    String cronExpression,
                                    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

cronExpression - The Cron expression for the subscription

emailOnEmpty - send email if filter returns no results

Returns:

GenericValue representing new subscription

createSubscription

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

Deprecated. Since v6.2. Quartz internals are no longer supported through the JIRA api use createSubscription(ApplicationUser, Long, String, String, Boolean)

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

createSubscription

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

Deprecated. Use createSubscription(ApplicationUser, Long, String, String, Boolean) instead. Since v6.0. 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

deleteSubscription

void deleteSubscription(Long subId)
                        throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

runSubscription

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

Deprecated. Use runSubscription(Long). Since v6.2

Throws:

org.ofbiz.core.entity.GenericEntityException

runSubscription

void runSubscription(Long subId)
                     throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

runSubscription

void runSubscription(ApplicationUser user,
                   Long subId)
                     throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

runSubscription

void runSubscription(com.atlassian.crowd.embedded.api.User user,
                   Long subId)
                     throws org.ofbiz.core.entity.GenericEntityException

Deprecated. Use runSubscription(com.atlassian.jira.user.ApplicationUser, Long) instead. Since v6.0.

Throws:

org.ofbiz.core.entity.GenericEntityException

getFilterSubscription

FilterSubscription getFilterSubscription(Long subId)
                                         throws org.ofbiz.core.entity.GenericEntityException

Get a subscription by Id

Parameters:

subId - Subscription Id

Returns:

Subscription

Throws:

org.ofbiz.core.entity.GenericEntityException

Since:

v6.2

getSubscriptionFromTriggerName

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

Deprecated. Since v6.2. Quartz internals are no longer supported through the JIRA api. Use getFilterSubscription(Long) instead

Throws:

org.ofbiz.core.entity.GenericEntityException

getTriggerFromSubscription

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

Deprecated. Since v6.2. Quartz internals are no longer supported through the JIRA api

updateSubscription

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

Deprecated. Since v6.2. Quartz internals are no longer supported through the JIRA api use updateSubscription(ApplicationUser, Long, String, String, Boolean)

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.

updateSubscription

void updateSubscription(ApplicationUser user,
                      Long subscriptionId,
                      String groupName,
                      String cronExpression,
                      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

cronExpression - The Cron expression to update the subscription with

Throws:

DataAccessException - if there is a problem persisting the data.

updateSubscription

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

Deprecated. Use use updateSubscription(ApplicationUser, Long, String, String, Boolean) instead. Since v6.0.

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.

getAllFilterSubscriptions

List<FilterSubscription> getAllFilterSubscriptions(Long filterId)

getAllFilterSubscriptions

List<FilterSubscription> getAllFilterSubscriptions()

getAllSubscriptions

List<org.ofbiz.core.entity.GenericValue> getAllSubscriptions(Long filterId)

Deprecated. Use use getAllFilterSubscriptions(Long filterId) instead. Since v6.2.

getAllSubscriptions

List<org.ofbiz.core.entity.GenericValue> getAllSubscriptions()

Deprecated. Use use getAllFilterSubscriptions() instead. Since v6.2.

deleteSubscriptionsForUser

void deleteSubscriptionsForUser(ApplicationUser user)
                                throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

deleteSubscriptionsForUser

void deleteSubscriptionsForUser(com.atlassian.crowd.embedded.api.User user)
                                throws org.ofbiz.core.entity.GenericEntityException

Deprecated. Use deleteSubscriptionsForUser(ApplicationUser) instead. Since v6.0.

Throws:

org.ofbiz.core.entity.GenericEntityException

deleteSubscriptionsForGroup

void deleteSubscriptionsForGroup(com.atlassian.crowd.embedded.api.Group group)
                                 throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getCronExpressionForSubscription

String getCronExpressionForSubscription(FilterSubscription subscription)

Retrieve the cron expression associated with this subscription

Parameters:

subscription -

Returns:

the cron expression associated with this subscription

getNextSendTime

@Nullable
Date getNextSendTime(@Nonnull
                            FilterSubscription sub)

Returns the next send time for this subscription. This may return null if the scheduler does not support the reporting of next send times.

Parameters:

sub - The subscription

Returns:

Next send time