org.xwiki.rendering.macro.jira

Class JIRAMacroParameters

java.lang.Object

org.xwiki.rendering.macro.jira.JIRAMacroParameters

public class JIRAMacroParameters
extends Object

Parameters for the org.xwiki.rendering.internal.macro.jira.JIRAMacro Macro.

Since:

4.2M1

Version:

$Id: b81ebc5585d79a9d106b95f9e12096e270f41ef3 $

Constructor Summary

Constructors

Constructor and Description
JIRAMacroParameters()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getDefaultFieldNames()
List<String>	getFieldNames()
List<String>	getFields()
String	getSource()
String	getStyle()
String	getURL()
void	setFieldNames(List<String> fieldNames)
void	setFields(List<String> fields)
void	setSource(String source)
void	setStyle(String style)
void	setURL(String url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JIRAMacroParameters

public JIRAMacroParameters()

Method Detail

setURL

public void setURL(String url)

Parameters:

url - see getURL()

getURL

public String getURL()

Returns:

the JIRA Server URL (eg "http://jira.xwiki.org")

setSource

public void setSource(String source)

Parameters:

source - see getSource()

getSource

public String getSource()

Returns:

the hint of the data source to use to fetch JIRA issues

setStyle

public void setStyle(String style)

Parameters:

style - see getStyle()

getStyle

public String getStyle()

Returns:

the hint of the Displayer to use to display JIRA issues

getDefaultFieldNames

public Map<String,String> getDefaultFieldNames()

Returns:

the default field names (used for example by the Table displayer as table headers)

setFields

public void setFields(List<String> fields)

Parameters:

fields - see getFields()

getFields

public List<String> getFields()

Returns:

the list of JIRA fields to display (if not defined, a default list of fields defined by the chosen Displayer will be used)

setFieldNames

public void setFieldNames(List<String> fieldNames)

Parameters:

fieldNames - see getFieldNames()

getFieldNames

public List<String> getFieldNames()

Returns:

the names to use for JIRA issue fields for Displayers displaying the field names (eg the Table Data Source)