com.atlassian.jira.issue.subscription
Interface SubscriptionManager

All Known Implementing Classes:
DefaultSubscriptionManager

@PublicApi
public interface SubscriptionManager


Method Summary
 org.ofbiz.core.entity.GenericValue createSubscription(ApplicationUser user, Long filterId, String groupName, Long period, Boolean emailOnEmpty)
           
 org.ofbiz.core.entity.GenericValue createSubscription(ApplicationUser 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
 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(com.atlassian.jira.user.ApplicationUser, Long, String, org.quartz.Trigger, 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<org.ofbiz.core.entity.GenericValue> getAllSubscriptions()
           
 List<org.ofbiz.core.entity.GenericValue> getAllSubscriptions(Long filterId)
           
 org.ofbiz.core.entity.GenericValue getSubscription(ApplicationUser user, Long subId)
           
 org.ofbiz.core.entity.GenericValue getSubscription(com.atlassian.crowd.embedded.api.User user, Long subId)
          Deprecated. Use getSubscription(ApplicationUser, Long) instead. Since v6.0.
 org.ofbiz.core.entity.GenericValue getSubscriptionFromTriggerName(String triggerName)
           
 List<org.ofbiz.core.entity.GenericValue> getSubscriptions(ApplicationUser user, Long filterId)
           
 List<org.ofbiz.core.entity.GenericValue> getSubscriptions(com.atlassian.crowd.embedded.api.User user, Long filterId)
          Deprecated. Use getSubscriptions(ApplicationUser, Long) instead. Since v6.0.
 org.quartz.Trigger getTriggerFromSubscription(org.ofbiz.core.entity.GenericValue subscription)
           
 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)
           
 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, org.quartz.Trigger trigger, Boolean emailOnEmpty)
           
 void updateSubscription(com.atlassian.crowd.embedded.api.User user, Long subscriptionId, String groupName, org.quartz.Trigger trigger, Boolean emailOnEmpty)
          Deprecated. Use updateSubscription(ApplicationUser, Long, String, org.quartz.Trigger, Boolean) instead. Since v6.0.
 

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

getSubscription

org.ofbiz.core.entity.GenericValue getSubscription(ApplicationUser user,
                                                   Long subId)
                                                   throws org.ofbiz.core.entity.GenericEntityException
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 getSubscription(ApplicationUser, Long) instead. Since v6.0.

Throws:
org.ofbiz.core.entity.GenericEntityException

getSubscriptions

List<org.ofbiz.core.entity.GenericValue> getSubscriptions(ApplicationUser user,
                                                          Long filterId)
                                                          throws org.ofbiz.core.entity.GenericEntityException
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 getSubscriptions(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

org.ofbiz.core.entity.GenericValue createSubscription(ApplicationUser 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

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(com.atlassian.jira.user.ApplicationUser, Long, String, org.quartz.Trigger, 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,
                               org.quartz.SchedulerException
Throws:
org.ofbiz.core.entity.GenericEntityException
org.quartz.SchedulerException

runSubscription

void runSubscription(org.ofbiz.core.entity.GenericValue 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

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(ApplicationUser 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.

updateSubscription

void updateSubscription(com.atlassian.crowd.embedded.api.User user,
                        Long subscriptionId,
                        String groupName,
                        org.quartz.Trigger trigger,
                        Boolean emailOnEmpty)
                        throws DataAccessException
Deprecated. Use updateSubscription(ApplicationUser, Long, String, org.quartz.Trigger, 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.

getAllSubscriptions

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

getAllSubscriptions

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

deleteSubscriptionsForUser

void deleteSubscriptionsForUser(ApplicationUser user)
                                throws org.ofbiz.core.entity.GenericEntityException,
                                       org.quartz.SchedulerException
Throws:
org.ofbiz.core.entity.GenericEntityException
org.quartz.SchedulerException

deleteSubscriptionsForUser

void deleteSubscriptionsForUser(com.atlassian.crowd.embedded.api.User user)
                                throws org.ofbiz.core.entity.GenericEntityException,
                                       org.quartz.SchedulerException
Deprecated. Use deleteSubscriptionsForUser(ApplicationUser) instead. Since v6.0.

Throws:
org.ofbiz.core.entity.GenericEntityException
org.quartz.SchedulerException

deleteSubscriptionsForGroup

void deleteSubscriptionsForGroup(com.atlassian.crowd.embedded.api.Group group)
                                 throws org.ofbiz.core.entity.GenericEntityException,
                                        org.quartz.SchedulerException
Throws:
org.ofbiz.core.entity.GenericEntityException
org.quartz.SchedulerException


Copyright © 2002-2013 Atlassian. All Rights Reserved.