org.pentaho.platform.repository.subscription
Class SubscriptionRepositoryHelper

java.lang.Object
  extended by org.pentaho.platform.repository.subscription.SubscriptionRepositoryHelper

public class SubscriptionRepositoryHelper
extends Object

Provides "algorithms" to operate on an instance of ISolutionRepository. The algorithms are frequently used sequences of method calls on ISolutionRepository. The idea is that ISolutionRepository's interface should be minimal be sufficient, and this class can provide methods that are not minimal, but perform common sequences of operations on the ISubscriptionRepository.

Author:
Steven Barkdull

Method Summary
static ISchedule addScheduleAndContent(ISubscriptionRepository subscriptionRepository, String title, String schedRef, String desc, String cronExpr, Integer repeatCount, Integer repeatInterval, String group, Date startDate, Date endDate, String[] actionRefs)
           
static ISchedule addScheduleWithoutContent(ISubscriptionRepository subscriptionRepository, String title, String schedRef, String desc, String cronExpr, Integer repeatCount, Integer repeatInterval, String group, Date startDate, Date endDate)
           
static void deleteScheduleContentAndSubscription(ISubscriptionRepository subscriptionRepository, ISchedule schedule)
           
static ISchedule editScheduleAndContent(ISubscriptionRepository subscriptionRepository, String schedId, String title, String schedRef, String desc, String cronExpr, Integer repeatCount, Integer repeatInterval, String group, Date startDate, Date endDate, String[] actionRefs)
           
static ISchedule editScheduleWithoutContent(ISubscriptionRepository subscriptionRepository, String schedId, String title, String schedRef, String desc, String cronExpr, Integer repeatCount, Integer repeatInterval, String group, Date startDate, Date endDate)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

deleteScheduleContentAndSubscription

public static void deleteScheduleContentAndSubscription(ISubscriptionRepository subscriptionRepository,
                                                        ISchedule schedule)
                                                 throws SubscriptionRepositoryCheckedException,
                                                        SubscriptionSchedulerException
Parameters:
subscriptionRepository -
schedule -
Throws:
SubscriptionRepositoryCheckedException - thrown if: subscriptionRepository.deleteSubscriptionForSchedule() fails subscriptionRepository.deleteSubscription() fails subscriptionRepository.deleteContentForSchedule() fails subscriptionRepository.deleteSchedule() fails
SubscriptionSchedulerException - throw if: subscriptionRepository.deleteSubscribeContent() fails

editScheduleAndContent

public static ISchedule editScheduleAndContent(ISubscriptionRepository subscriptionRepository,
                                               String schedId,
                                               String title,
                                               String schedRef,
                                               String desc,
                                               String cronExpr,
                                               Integer repeatCount,
                                               Integer repeatInterval,
                                               String group,
                                               Date startDate,
                                               Date endDate,
                                               String[] actionRefs)
                                        throws SubscriptionRepositoryCheckedException
Throws:
SubscriptionRepositoryCheckedException

editScheduleWithoutContent

public static ISchedule editScheduleWithoutContent(ISubscriptionRepository subscriptionRepository,
                                                   String schedId,
                                                   String title,
                                                   String schedRef,
                                                   String desc,
                                                   String cronExpr,
                                                   Integer repeatCount,
                                                   Integer repeatInterval,
                                                   String group,
                                                   Date startDate,
                                                   Date endDate)
                                            throws SubscriptionRepositoryCheckedException
Throws:
SubscriptionRepositoryCheckedException

addScheduleAndContent

public static ISchedule addScheduleAndContent(ISubscriptionRepository subscriptionRepository,
                                              String title,
                                              String schedRef,
                                              String desc,
                                              String cronExpr,
                                              Integer repeatCount,
                                              Integer repeatInterval,
                                              String group,
                                              Date startDate,
                                              Date endDate,
                                              String[] actionRefs)
                                       throws SubscriptionRepositoryCheckedException
Throws:
SubscriptionRepositoryCheckedException

addScheduleWithoutContent

public static ISchedule addScheduleWithoutContent(ISubscriptionRepository subscriptionRepository,
                                                  String title,
                                                  String schedRef,
                                                  String desc,
                                                  String cronExpr,
                                                  Integer repeatCount,
                                                  Integer repeatInterval,
                                                  String group,
                                                  Date startDate,
                                                  Date endDate)
                                           throws SubscriptionRepositoryCheckedException
Throws:
SubscriptionRepositoryCheckedException