org.xwiki.rendering.macro.jira.JIRADataSource Maven / Gradle / Ivy

Go to download
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rendering.macro.jira;

import java.util.Collection;

import org.jdom2.Element;
import org.xwiki.component.annotation.Role;
import org.xwiki.rendering.macro.MacroExecutionException;

/**
 * Source to fetch data from a JIRA instance.
 *
 * @version $Id: 9a22b23b001da460078baa8a1bb0efc72db0a617 $
 * @since 4.2M1
 */
@Role
public interface JIRADataSource
{
    /**
     * @param macroContent the macro content which contains the source definition
     * @param parameters the macro parameters which can contain source-specific configuration information
     * @return the list of matching JIRA issues
     * @throws MacroExecutionException in case of an error while getting the JIRA data
     */
    Collection getData(String macroContent, JIRAMacroParameters parameters)
        throws MacroExecutionException;
}