SchedulerService.java

/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2009-2011 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing <license@opennms.org>
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.web.svclayer;

import java.util.List;

import org.opennms.api.reporting.parameter.ReportParameters;
import org.opennms.reporting.core.DeliveryOptions;
import org.opennms.web.svclayer.support.TriggerDescription;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.webflow.execution.RequestContext;

/**
 * <p>SchedulerService interface.</p>
 *
 * @author ranger
 * @version $Id: $
 * @since 1.8.1
 */
@Transactional(readOnly = true)
public interface SchedulerService {
    
    /**
     * <p>getTriggerDescriptions</p>
     *
     * @return a {@link java.util.List} object.
     */
    public abstract List<TriggerDescription> getTriggerDescriptions();

    /**
     * <p>removeTrigger</p>
     *
     * @param triggerName a {@link java.lang.String} object.
     */
    @Transactional(readOnly = false)
    public abstract void removeTrigger(String triggerName);
    
    /**
     * <p>removeTriggers</p>
     *
     * @param triggerNames an array of {@link java.lang.String} objects.
     */
    @Transactional(readOnly = false)
    public abstract void removeTriggers(String[] triggerNames);
    
    /**
     * <p>exists</p>
     *
     * @param triggerName a {@link java.lang.String} object.
     * @return a {@link java.lang.Boolean} object.
     */
    public abstract Boolean exists(String triggerName);

    /**
     * <p>addCronTrigger</p>
     *
     * @param id a {@link java.lang.String} object.
     * @param criteria a {@link org.opennms.api.reporting.parameter.ReportParameters} object.
     * @param deliveryOptions a {@link org.opennms.reporting.core.DeliveryOptions} object.
     * @param cronExpression a {@link java.lang.String} object.
     * @param context a {@link org.springframework.webflow.execution.RequestContext} object.
     * @return a {@link java.lang.String} object.
     */
    @Transactional(readOnly = false)
    public abstract String addCronTrigger(String id,
            ReportParameters criteria, 
            DeliveryOptions deliveryOptions,
            String cronExpression, 
            RequestContext context);

    /**
     * <p>execute</p>
     *
     * @param id a {@link java.lang.String} object.
     * @param criteria a {@link org.opennms.api.reporting.parameter.ReportParameters} object.
     * @param deliveryOptions a {@link org.opennms.reporting.core.DeliveryOptions} object.
     * @param context a {@link org.springframework.webflow.execution.RequestContext} object.
     * @return a {@link java.lang.String} object.
     */
    @Transactional(readOnly = false)
    public abstract String execute(String id,
            ReportParameters criteria, 
            DeliveryOptions deliveryOptions,
            RequestContext context);

}