com.atlassian.jira.bc.filter
Interface FilterSubscriptionService

public interface FilterSubscriptionService

Provides high level access to CRUD and query FilterSubscriptions.

Method Summary

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<org.ofbiz.core.entity.GenericValue>	getVisibleSubscriptions(User user, SearchRequest filter) Retrieves a list of subscriptions that a given user can see for a given filter.
Collection<org.ofbiz.core.entity.GenericValue>	getVisibleSubscriptions(com.atlassian.crowd.embedded.api.User 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 the Cron Trigger and subscription
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

Method Detail

validateCronExpression

void validateCronExpression(JiraServiceContext context,
                            String expr)

Validates a given cron expression Errors are passed back in the ErrorCollection of the JiraServiceContext

Parameters:

context - jira service context

expr - Expression to evaluate

storeSubscription

void storeSubscription(JiraServiceContext context,
                       Long filterId,
                       String groupName,
                       String expr,
                       boolean emailOnEmpty)

Create and store the Cron Trigger and subscription

Parameters:

context - jira service context

filterId - Id of the filter subscribing to

groupName - Sent to group (may be null if sent to self)

expr - Cron expression to store

emailOnEmpty - send email if filter returns no results

updateSubscription

void updateSubscription(JiraServiceContext context,
                        Long subscriptionId,
                        String groupName,
                        String expr,
                        boolean emailOnEmpty)

Updates the subscription to the new given values and persists.

Parameters:

context - jira service context

subscriptionId - Id of the subscription being updated

groupName - Sent to group (may be null if sent to self)

expr - Cron expression to store

emailOnEmpty - send email if filter returns no results

getPrettySchedule

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.

Parameters:

context - the jira service context.

cronExpression - a cron expression.

Returns:

a locale-specific sentence describing the cron string (or on failure, the cron string).

getVisibleSubscriptions

Collection<org.ofbiz.core.entity.GenericValue> getVisibleSubscriptions(User user,
                                                                       SearchRequest filter)

Retrieves a list of subscriptions that a given user can see for a given filter. I.e. The owner can see all subscriptions for a filter, otherwise you can only see your own subscriptions.

Parameters:

user - The user that can see the subscriptions

filter - The filter with teh associated subscriptions

Returns:

A Collection of GenericValue subscriptions

getVisibleSubscriptions

Collection<org.ofbiz.core.entity.GenericValue> getVisibleSubscriptions(com.atlassian.crowd.embedded.api.User user,
                                                                       SearchRequest filter)

Retrieves a list of subscriptions that a given user can see for a given filter. I.e. The owner can see all subscriptions for a filter, otherwise you can only see your own subscriptions.

Parameters:

user - The user that can see the subscriptions

filter - The filter with teh associated subscriptions

Returns:

A Collection of GenericValue subscriptions