de.smartics.maven.issues.bugzilla
Class BugzillaQueryData

java.lang.Object
  de.smartics.maven.issues.bugzilla.BugzillaQueryData

All Implemented Interfaces:

QueryData

public class BugzillaQueryData
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      QueryData
     
     

The data used to construct issue queries for Bugzilla.

Author:

Robert Reiner

Constructor Summary

BugzillaQueryData()
Default constructor.

Method Summary

String	createUrl(String connectionUrl) Creates the query URL to run against the issue management system.
String	getCommandType() Returns the type of the command executed.
String	getComponent() Returns the value for component.
String	getFilter() Returns the value for filter.
String	getKeywords() Returns the value for keywords.
String	getKeywordsType() Returns the value for keywordsType.
String	getOrder() Returns the order of the bugs returned.
String	getProduct() Returns the value for product.
String	getQueryName() Returns the name of the query to execute.
String	getResolution() Returns the value for resolution.
String	getStatus() Returns the value for status.
ArtifactVersionRange	getVersionRange() Returns the version range to query for.
void	setCommandType(String commandType) Sets the type of the command executed.
void	setComponent(String component) Sets the value for component.
void	setFilter(String filter) Sets the value for filter.
void	setKeywords(String keywords) Sets the value for keywords.
void	setKeywordsType(String keywordsType) Sets the value for keywordsType.
void	setOrder(String order) Sets the order of the bugs returned.
void	setProduct(String product) Sets the value for product.
void	setQueryName(String queryName) Sets the name of the query to execute.
void	setResolution(String resolution) Sets the value for resolution.
void	setStatus(String status) Sets the value for status.
void	setVersionRange(ArtifactVersionRange versionRange) Sets the version range to query for.

Methods inherited from class java.lang.Object

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

Constructor Detail

BugzillaQueryData

public BugzillaQueryData()

Default constructor.

Method Detail

getFilter

public String getFilter()

Returns the value for filter.

Defines the filter parameters to restrict which issues are retrieved from Bugzilla. The filter parameter must use the same format of url parameters that is used in a Bugzilla search.

Returns:

the value for filter.

setFilter

public void setFilter(String filter)

Sets the value for filter.

Defines the filter parameters to restrict which issues are retrieved from Bugzilla. The filter parameter must use the same format of url parameters that is used in a Bugzilla search.

Parameters:

filter - the value for filter.

getKeywords

public String getKeywords()

Returns the value for keywords.

Sets the keywords that you want to limit your report to include.

Returns:

the value for keywords.

setKeywords

public void setKeywords(String keywords)

Sets the value for keywords.

Sets the keywords that you want to limit your report to include.

Parameters:

keywords - the value for keywords.

getKeywordsType

public String getKeywordsType()

Returns the value for keywordsType.

Sets the handling of the keywords. May have any value but Bugzilla supports currently allwords, nowords, anywords.

Returns:

the value for keywordsType.

setKeywordsType

public void setKeywordsType(String keywordsType)

Sets the value for keywordsType.

Sets the handling of the keywords. May have any value but Bugzilla supports currently allwords, nowords, anywords.

Parameters:

keywordsType - the value for keywordsType.

getStatus

public String getStatus()

Returns the value for status.

Sets the status(es) that you want to limit your report to include. Valid statuses are: UNCONFIRMED, NEW, ASSIGNED, REOPENED, RESOLVED, VERIFIED, and CLOSED. Multiple values can be separated by commas.

Returns:

the value for status.

setStatus

public void setStatus(String status)

Sets the value for status.

Sets the status(es) that you want to limit your report to include. Valid statuses are: UNCONFIRMED, NEW, ASSIGNED, REOPENED, RESOLVED, VERIFIED, and CLOSED. Multiple values can be separated by commas.

Parameters:

status - the value for status.

getResolution

public String getResolution()

Returns the value for resolution.

Sets the resolution(s) that you want to limit your report to include. Valid statuses are: FIXED, INVALID, WONTFIX, LATER, REMIND, DUPLICATE, WORKSFORME, and MOVED. Multiple values can be separated by commas.

Returns:

the value for resolution.

setResolution

public void setResolution(String resolution)

Sets the value for resolution.

Sets the resolution(s) that you want to limit your report to include. Valid statuses are: FIXED, INVALID, WONTFIX, LATER, REMIND, DUPLICATE, WORKSFORME, and MOVED. Multiple values can be separated by commas.

Parameters:

resolution - the value for resolution.

getComponent

public String getComponent()

Returns the value for component.

Sets the component(s) that you want to limit your report to include. Multiple components can be separated by commas. If this is set to empty - that means all components.

Returns:

the value for component.

setComponent

public void setComponent(String component)

Sets the value for component.

Sets the component(s) that you want to limit your report to include. Multiple components can be separated by commas. If this is set to empty - that means all components.

Parameters:

component - the value for component.

getProduct

public String getProduct()

Returns the value for product.

Sets the product(s) that you want to limit your report to include. Multiple products can be separated by commas. If this is set to empty - that means all products.

Returns:

the value for product.

setProduct

public void setProduct(String product)

Sets the value for product.

Sets the product(s) that you want to limit your report to include. Multiple products can be separated by commas. If this is set to empty - that means all products.

Parameters:

product - the value for product.

getOrder

public String getOrder()

Returns the order of the bugs returned.

Returns:

the order of the bugs returned.

setOrder

public void setOrder(String order)

Sets the order of the bugs returned.

Parameters:

order - the order of the bugs returned.

getQueryName

public String getQueryName()

Returns the name of the query to execute. If the query name is specified none of the other query properties is taken into account.

Returns:

the name of the query to execute.

setQueryName

public void setQueryName(String queryName)

Sets the name of the query to execute. If the query name is specified none of the other query properties is taken into account.

Parameters:

queryName - the name of the query to execute.

getCommandType

public String getCommandType()

Returns the type of the command executed. This property is currently only relevant is queryName is set.

Returns:

the type of the command executed.

setCommandType

public void setCommandType(String commandType)

Sets the type of the command executed. This property is currently only relevant is queryName is set.

Parameters:

commandType - the type of the command executed.

getVersionRange

public ArtifactVersionRange getVersionRange()

Returns the version range to query for.

Returns:

the version range to query for.

setVersionRange

public void setVersionRange(ArtifactVersionRange versionRange)

Sets the version range to query for.

Parameters:

versionRange - the version range to query for.

createUrl

public String createUrl(String connectionUrl)
                 throws MavenReportException

Creates the query URL to run against the issue management system.

Specified by:

createUrl in interface QueryData

Parameters:

connectionUrl - the URL to the issue management system. The instance is responsible to add the name of the query service and the query parameters.

Returns:

the URL to fetch issues from the management system that match the criteria configured in this query data instance.

Throws:

MavenReportException - if the URL cannot be created.

See Also:

QueryData.createUrl(String)