@PublicApi
public interface FilterSubscriptionService
Modifier and Type | Method and Description |
---|---|
String |
getCronExpression(JiraServiceContext context,
FilterSubscription subscription)
Retrieve the cron expression associated with this subscription
|
Date |
getNextSendTime(FilterSubscription sub)
Returns the next send time for this subscription.
|
String |
getPrettySchedule(JiraServiceContext context,
String cronExpression)
Renders a human readable description of the given cron expression or returns the cron expression if
it can't be parsed by the
CronExpressionParser . |
Collection<FilterSubscription> |
getVisibleFilterSubscriptions(ApplicationUser user,
SearchRequest filter)
Retrieves a list of subscriptions that a given user can see for a given filter.
|
void |
storeSubscription(JiraServiceContext context,
Long filterId,
String groupName,
String expr,
boolean emailOnEmpty)
Create and store a subscription that uses the given cron expression
|
void |
updateSubscription(JiraServiceContext context,
Long subscriptionId,
String groupName,
String expr,
boolean emailOnEmpty)
Updates the subscription to the new given values and persists.
|
void |
validateCronExpression(JiraServiceContext context,
String expr)
Validates a given cron expression
Errors are passed back in the
ErrorCollection
of the JiraServiceContext |
void validateCronExpression(JiraServiceContext context, String expr)
ErrorCollection
of the JiraServiceContext
context
- jira service contextexpr
- Expression to evaluatevoid storeSubscription(JiraServiceContext context, Long filterId, String groupName, String expr, boolean emailOnEmpty)
context
- jira service contextfilterId
- Id of the filter subscribing togroupName
- Sent to group (may be null if sent to self)expr
- Cron expression to storeemailOnEmpty
- send email if filter returns no resultsvoid updateSubscription(JiraServiceContext context, Long subscriptionId, String groupName, String expr, boolean emailOnEmpty)
context
- jira service contextsubscriptionId
- Id of the subscription being updatedgroupName
- Sent to group (may be null if sent to self)expr
- Cron expression to storeemailOnEmpty
- send email if filter returns no resultsString getPrettySchedule(JiraServiceContext context, String cronExpression)
CronExpressionParser
.context
- the jira service context.cronExpression
- a cron expression.Collection<FilterSubscription> getVisibleFilterSubscriptions(ApplicationUser user, SearchRequest filter)
user
- The user that can see the subscriptionsfilter
- The filter with teh associated subscriptionsString getCronExpression(JiraServiceContext context, FilterSubscription subscription)
subscription
- @Nullable Date getNextSendTime(@Nonnull FilterSubscription sub)
sub
- The subscriptionCopyright © 2002-2017 Atlassian. All Rights Reserved.