com.atlassian.jira.issue.subscription
Interface SubscriptionManager

All Known Implementing Classes:
DefaultSubscriptionManager

public interface SubscriptionManager


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

Method Detail

hasSubscription

boolean hasSubscription(com.opensymphony.user.User user,
                        java.lang.Long filterId)
                        throws org.ofbiz.core.entity.GenericEntityException
Throws:
org.ofbiz.core.entity.GenericEntityException

getSubscription

org.ofbiz.core.entity.GenericValue getSubscription(com.opensymphony.user.User user,
                                                   java.lang.Long subId)
                                                   throws org.ofbiz.core.entity.GenericEntityException
Throws:
org.ofbiz.core.entity.GenericEntityException

getSubscriptions

java.util.List<org.ofbiz.core.entity.GenericValue> getSubscriptions(com.opensymphony.user.User user,
                                                                    java.lang.Long filterId)
                                                                    throws org.ofbiz.core.entity.GenericEntityException
Throws:
org.ofbiz.core.entity.GenericEntityException

createSubscription

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

createSubscription

org.ofbiz.core.entity.GenericValue createSubscription(com.opensymphony.user.User user,
                                                      java.lang.Long filterId,
                                                      java.lang.String groupName,
                                                      org.quartz.Trigger trigger,
                                                      java.lang.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:
java.lang.Exception

deleteSubscription

void deleteSubscription(java.lang.Long subId)
                        throws java.lang.Exception
Throws:
java.lang.Exception

runSubscription

void runSubscription(org.ofbiz.core.entity.GenericValue subId)
                     throws java.lang.Exception
Throws:
java.lang.Exception

runSubscription

void runSubscription(com.opensymphony.user.User u,
                     java.lang.Long subId)
                     throws java.lang.Exception
Throws:
java.lang.Exception

getSubscriptionFromTriggerName

org.ofbiz.core.entity.GenericValue getSubscriptionFromTriggerName(java.lang.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

@Deprecated
void updateSubscription(com.opensymphony.user.User user,
                                   java.lang.Long subscriptionId,
                                   java.util.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(com.opensymphony.user.User user,
                        java.lang.Long subscriptionId,
                        java.lang.String groupName,
                        org.quartz.Trigger trigger,
                        java.lang.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

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

getAllSubscriptions

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

deleteSubscriptionsForUser

void deleteSubscriptionsForUser(com.opensymphony.user.User user)
                                throws java.lang.Exception
Throws:
java.lang.Exception

deleteSubscriptionsForGroup

void deleteSubscriptionsForGroup(com.opensymphony.user.Group group)
                                 throws java.lang.Exception
Throws:
java.lang.Exception


Copyright © 2002-2010 Atlassian. All Rights Reserved.