org.tigris.scarab.util.word
Class QueryResult

java.lang.Object
  org.tigris.scarab.util.word.QueryResult

public class QueryResult

extends java.lang.Object

This class is created by the IssueSearch object to contain a single result. It represents a row on the IssueList.vm screen. It is mostly a data structure with some additional functionality to format a multivalued attribute as CSV.

Author:

John McNally

Constructor Summary

(package private)

QueryResult(IssueSearch search) Ctor.

Method Summary

java.util.List	getAttributeValues() Get the AttributeValues value.
java.util.List	getAttributeValuesAsCSV() Get the AttributeValues value.
java.lang.Integer	getCreatedBy()
ScarabUser	getCreatedByUser()
java.util.Date	getCreatedDate()
java.lang.String	getIdCount() Get the IdCount value.
java.lang.String	getIdPrefix() Get the IdPrefix value.
java.lang.String	getIssueId() Get the IssueId value.
java.lang.Integer	getIssueTypeId() Get the IssueTypeId value.
java.lang.Integer	getModifiedBy()
ScarabUser	getModifiedByUser()
java.util.Date	getModifiedDate()
Module	getModule() Get the Module related thru getModuleId().
java.lang.Integer	getModuleId() Get the ModuleId value.
RModuleIssueType	getRModuleIssueType() Get the RModuleIssueType related thru getModuleId() and getIssueTypeId().
java.lang.String	getUniqueId() Combines getIdPrefix() and getIdCount()
void	populateInternalAttributes(java.util.List preferences) Populate any attribute considered 'internal' with the proper value.
void	populateInternalAttributes(java.util.List preferences, ScarabLocalizationTool l10n) Populate, including localization of dates, any attribute considered 'internal' with the proper value.
void	setAttributeValues(java.util.List newAttributeValues) Set the AttributeValues value.
void	setCreatedBy(java.lang.Integer createdBy)
void	setCreatedDate(java.util.Date created)
void	setIdCount(java.lang.String newIdCount) Set the IdCount value.
void	setIdPrefix(java.lang.String newIdPrefix) Set the IdPrefix value.
void	setIssueId(java.lang.String newIssueId) Set the IssueId value.
void	setIssueTypeId(java.lang.Integer newIssueTypeId) Set the IssueTypeId value.
void	setModifiedBy(java.lang.Integer modified)
void	setModifiedDate(java.util.Date modifiedDate)
void	setModuleId(java.lang.Integer newModuleId) Set the ModuleId value.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryResult

QueryResult(IssueSearch search)

Ctor. Should only be called by an IssueSearch.

Parameters:

search - the IssueSearch that created this result

Method Detail

getIssueId

public final java.lang.String getIssueId()

Get the IssueId value.

Returns:

the IssueId value.

setIssueId

public final void setIssueId(java.lang.String newIssueId)

Set the IssueId value.

Parameters:

newIssueId - The new IssueId value.

getIdPrefix

public final java.lang.String getIdPrefix()

Get the IdPrefix value.

Returns:

the IdPrefix value.

setIdPrefix

public final void setIdPrefix(java.lang.String newIdPrefix)

Set the IdPrefix value.

Parameters:

newIdPrefix - The new IdPrefix value.

getIdCount

public final java.lang.String getIdCount()

Get the IdCount value.

Returns:

the IdCount value.

setIdCount

public final void setIdCount(java.lang.String newIdCount)

Set the IdCount value.

Parameters:

newIdCount - The new IdCount value.

getUniqueId

public final java.lang.String getUniqueId()

Combines getIdPrefix() and getIdCount()

getAttributeValues

public final java.util.List getAttributeValues()

Get the AttributeValues value.

Returns:

the AttributeValues value.

getAttributeValuesAsCSV

public final java.util.List getAttributeValuesAsCSV()

Get the AttributeValues value.

Returns:

the AttributeValues value.

populateInternalAttributes

public void populateInternalAttributes(java.util.List preferences)

Populate any attribute considered 'internal' with the proper value. To decide which should be filled, it will use the list 'preferences', which shares the same order than the attribute list.

Parameters:

preferences -

populateInternalAttributes

public void populateInternalAttributes(java.util.List preferences,
                                       ScarabLocalizationTool l10n)

Populate, including localization of dates, any attribute considered 'internal' with the proper value. To decide which should be filled, it will use the list 'preferences', which shares the same order than the attribute list.

Parameters:

preferences -

setAttributeValues

public final void setAttributeValues(java.util.List newAttributeValues)

Set the AttributeValues value.

Parameters:

newAttributeValues - The new AttributeValues value.

getModuleId

public final java.lang.Integer getModuleId()

Get the ModuleId value.

Returns:

the ModuleId value.

setModuleId

public final void setModuleId(java.lang.Integer newModuleId)

Set the ModuleId value.

Parameters:

newModuleId - The new ModuleId value.

getModule

public final Module getModule()
                       throws org.apache.torque.TorqueException

Get the Module related thru getModuleId(). This method provides caching so that multiple QueryResult objects in the same resultset save db hits.

Throws:

org.apache.torque.TorqueException

getIssueTypeId

public final java.lang.Integer getIssueTypeId()

Get the IssueTypeId value.

Returns:

the IssueTypeId value.

setIssueTypeId

public final void setIssueTypeId(java.lang.Integer newIssueTypeId)

Set the IssueTypeId value.

Parameters:

newIssueTypeId - The new IssueTypeId value.

getRModuleIssueType

public final RModuleIssueType getRModuleIssueType()
                                           throws org.apache.torque.TorqueException

Get the RModuleIssueType related thru getModuleId() and getIssueTypeId(). This method provides caching so that multiple QueryResult objects in the same resultset save db hits.

Throws:

org.apache.torque.TorqueException

setCreatedBy

public void setCreatedBy(java.lang.Integer createdBy)

getCreatedBy

public java.lang.Integer getCreatedBy()

getCreatedByUser

public ScarabUser getCreatedByUser()

setCreatedDate

public void setCreatedDate(java.util.Date created)

getCreatedDate

public java.util.Date getCreatedDate()

setModifiedBy

public void setModifiedBy(java.lang.Integer modified)

getModifiedBy

public java.lang.Integer getModifiedBy()

getModifiedByUser

public ScarabUser getModifiedByUser()

setModifiedDate

public void setModifiedDate(java.util.Date modifiedDate)

getModifiedDate

public java.util.Date getModifiedDate()