| org.tigris.scarab.om.Issue
 org.tigris.scarab.util.word.IssueSearch
| IssueSearch | | public class IssueSearch extends Issue (Code) | | A utility class to build up and carry out a search for
similar issues. It subclasses Issue for functionality, it is
not a more specific type of Issue.
author:
John McNally
version:
$Id: IssueSearch.java 10382 2006-12-13 17:02:35Z dabbous $ |
| CREATED_BY_KEY | | final public static String CREATED_BY_KEY(Code) | | |
| addUserCriteria | | public void addUserCriteria(String userId, String searchCriteria)(Code) | | Describe addUserSearch method here.
Parameters:
userId - a String represention of the PrimaryKey
Parameters:
searchCriteria - a String either a String representation of an Attribute PrimaryKey, or the Strings "created_by" "any" |
| close | | public void close()(Code) | | Releases any managed resources associated with this search
(e.g. database connections, etc.).
|
| finalize | | protected void finalize() throws Throwable(Code) | | Called by the garbage collector to release any database
resources associated with this query.
See Also: IssueSearch.close() |
| getAllAvailableAttributeValuesMap | | public LinkedMap getAllAvailableAttributeValuesMap() throws Exception(Code) | | returns the list of attribute values
for all attributes in the current module.
throws:
Exception - |
| getCommentQuery | | public String getCommentQuery()(Code) | | Get the value of commentQuery.
value of commentQuery. |
| getCommonAttributeValuesMap | | public LinkedMap getCommonAttributeValuesMap() throws Exception(Code) | | returns the list of attribute values
for all attributes in the current module
and defined for all currently searched issueTypes.
throws:
Exception - |
| getIssueListAttributeColumns | | public List getIssueListAttributeColumns()(Code) | | |
| getMaxDate | | public String getMaxDate()(Code) | | Get the value of maxDate.
value of maxDate. |
| getMaxId | | public String getMaxId()(Code) | | Get the value of maxId.
value of maxId. |
| getMinDate | | public String getMinDate()(Code) | | Get the value of minDate.
value of minDate. |
| getMinId | | public String getMinId()(Code) | | Get the value of minId.
value of minId. |
| getMinVotes | | public int getMinVotes()(Code) | | Get the value of minVotes.
value of minVotes. |
| getModule | | Module getModule(Integer id) throws TorqueException(Code) | | Used by QueryResult to avoid multiple db hits in the event caching
is not being used application-wide. It is used if the IssueList.vm
template is printing the module names next to each issue id.
As this IssueSearch object is short-lived, use of a simple Map based
cache is ok, need to re-examine if the lifespan is increased.
Parameters:
id - an Integer value a Module value
exception:
TorqueException - if an error occurs |
| getOptionAttributeValues | | public List getOptionAttributeValues() throws Exception(Code) | | Returns OptionAttributes which have been marked for Quick search.
a List value
exception:
Exception - if an error occurs |
| getQueryResults | | public IteratorWithSize getQueryResults() throws ComplexQueryException, Exception(Code) | | Get a List of Issues that match the criteria given by this
SearchIssue's searchWords and the quick search attribute values.
Perform a logical AND on partial queries (in text searches)
a List value
exception:
Exception - if an error occurs |
| getQueryResults | | public IteratorWithSize getQueryResults(boolean mergePartialQueries) throws ComplexQueryException, Exception(Code) | | Get a List of Issues that match the criteria given by this
SearchIssue's searchWords and the quick search attribute values.
if (mergePartialQueries==true) perform a logical OR on partial queries,
otherwise perform a logical AND on partial queries.
a List value
exception:
Exception - if an error occurs |
| getQuickSearchOptionAttributeValues | | public List getQuickSearchOptionAttributeValues() throws Exception(Code) | | Returns OptionAttributes which have been marked for Quick search.
a List value
exception:
Exception - if an error occurs |
| getQuickSearchTextAttributeValues | | public List getQuickSearchTextAttributeValues() throws Exception(Code) | | |
| getRModuleIssueType | | RModuleIssueType getRModuleIssueType(Integer moduleId, Integer issueTypeId) throws TorqueException(Code) | | Used by QueryResult to avoid multiple db hits in the event caching
is not being used application-wide. It is used if the IssueList.vm
template is printing the issue type names next to each issue id.
As this IssueSearch object is short-lived, use of a simple Map based
cache is ok, need to re-examine if the lifespan is increased.
Parameters:
moduleId - an Integer value
Parameters:
issueTypeId - an Integer value a RModuleIssueType value
exception:
TorqueException - if an error occurs |
| getSortAttributeId | | public Integer getSortAttributeId()(Code) | | Get the value of sortAttributeId.
value of SortAttributeId. |
| getSortInternalAttribute | | public String getSortInternalAttribute()(Code) | | |
| getSortPolarity | | public String getSortPolarity()(Code) | | Whether to do SQL sorting in DESC or
ASC order (the default being the latter).
value of sortPolarity. |
| getStateChangeAttributeId | | public Integer getStateChangeAttributeId()(Code) | | Get the value of stateChangeAttributeId.
value of stateChangeAttributeId. |
| getStateChangeFromDate | | public String getStateChangeFromDate()(Code) | | Get the value of stateChangeFromDate.
value of stateChangeFromDate. |
| getStateChangeFromOptionId | | public Integer getStateChangeFromOptionId()(Code) | | Get the value of stateChangeFromOptionId.
value of stateChangeFromOptionId. |
| getStateChangeToDate | | public String getStateChangeToDate()(Code) | | Get the value of stateChangeToDate.
value of stateChangeToDate. |
| getStateChangeToOptionId | | public Integer getStateChangeToOptionId()(Code) | | Get the value of stateChangeToOptionId.
value of stateChangeToOptionId. |
| getTextScope | | public Integer[] getTextScope() throws Exception(Code) | | Get the value of textScope. if the scope is not set then all
text attributes are returned. if there are no relevant text
attributes null will be returned.
value of textScope. |
| getUserAttributes | | public List getUserAttributes() throws Exception(Code) | | The list of attributes of type "user" for the module(s)to search in. |
| isOperable | | public boolean isOperable()(Code) | | |
| isXMITSearch | | public boolean isXMITSearch()(Code) | | |
| parseDate | | public Date parseDate(String dateString, boolean addTwentyFourHours) throws ParseException(Code) | | Attempts to parse a atring as a date, first using the locale-sepcific
short date format, and then the ISO standard "yyyy-mm-dd". If it sees
a ':' character in the date string then the string will be interpreted
as a date and time. Throws a ParseException if the String does
not contain a suitable format.
Parameters:
dateString - a String value
Parameters:
locale - the locale to use when determining the date patternsto try.
Parameters:
addTwentyFourHours - if no time is given in the date string andthis flag is true, then 24 hours - 1 msec will be added to the date. a Date value |
| setCommentQuery | | public void setCommentQuery(String v)(Code) | | Set the value of commentQuery.
Parameters:
v - Value to assign to commentQuery. |
| setIsOperable | | public void setIsOperable(boolean state)(Code) | | The issue can be flagged as inoperable. This can happen when
a syntax check on the search criteria fails (e.g. invalid syntax on Date patterns)
Parameters:
state - |
| setIssueListAttributeColumns | | public void setIssueListAttributeColumns(List rmuas)(Code) | | List of attributes to show with each issue.
Parameters:
rmuas - a List of RModuleUserAttribute objects |
| setLocalizationTool | | public void setLocalizationTool(ScarabLocalizationTool l10nTool)(Code) | | Allows setting the L10N tool for using when is needed to know
the user's locale (example, when parsing date parameters)
Parameters:
l10nTool - |
| setMaxDate | | public void setMaxDate(String newMaxDate)(Code) | | Set the value of maxDate.
Parameters:
newMaxDate - Value to assign to maxDate. |
| setMaxId | | public void setMaxId(String v)(Code) | | Set the value of maxId.
Parameters:
v - Value to assign to maxId. |
| setMinDate | | public void setMinDate(String newMinDate)(Code) | | Set the value of minDate.
Parameters:
newMinDate - Value to assign to minDate. |
| setMinId | | public void setMinId(String v)(Code) | | Set the value of minId.
Parameters:
v - Value to assign to minId. |
| setMinVotes | | public void setMinVotes(int v)(Code) | | Set the value of minVotes.
Parameters:
v - Value to assign to minVotes. |
| setQuery | | public void setQuery(String query) throws Exception(Code) | | The query currently being launched, so we can access any value from it.
Parameters:
query - |
| setSortAttributeId | | public void setSortAttributeId(Integer v)(Code) | | Set the value of sortAttributeId.
Parameters:
v - Value to assign to sortAttributeId. |
| setSortInternalAttribute | | public void setSortInternalAttribute(String internal)(Code) | | |
| setSortPolarity | | public void setSortPolarity(String v)(Code) | | Set the value of sortPolarity.
Parameters:
v - Value to assign to sortPolarity. |
| setStateChangeAttributeId | | public void setStateChangeAttributeId(Integer v)(Code) | | Set the value of stateChangeAttributeId.
Parameters:
v - Value to assign to stateChangeAttributeId. |
| setStateChangeFromDate | | public void setStateChangeFromDate(String fromDate)(Code) | | Set the value of stateChangeFromDate.
Parameters:
fromDate - Value to assign to stateChangeFromDate. |
| setStateChangeFromOptionId | | public void setStateChangeFromOptionId(Integer v)(Code) | | Set the value of stateChangeFromOptionId.
Parameters:
v - Value to assign to stateChangeFromOptionId. |
| setStateChangeToDate | | public void setStateChangeToDate(String toDate)(Code) | | Set the value of stateChangeToDate.
Parameters:
toDate - Value to assign to stateChangeToDate. |
| setStateChangeToOptionId | | public void setStateChangeToOptionId(Integer v)(Code) | | Set the value of stateChangeToOptionId.
Parameters:
v - Value to assign to stateChangeToOptionId. |
| setTextScope | | public void setTextScope(Integer[] v) throws Exception(Code) | | Set the value of textScope.
Parameters:
v - Value to assign to textScope. |
| Methods inherited from org.tigris.scarab.om.Issue | public void addActivity(Activity activity) throws TorqueException(Code)(Java Doc)
public void addAttributeValue(AttributeValue aval) throws TorqueException(Code)(Java Doc)
public ActivitySet addComment(Attachment attachment, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet addComment(ActivitySet activitySet, Attachment attachment, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public synchronized void addFile(Attachment attachment, ScarabUser user) throws TorqueException(Code)(Java Doc)
public ActivitySet addUrl(Attachment attachment, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet addUrl(ActivitySet activitySet, Attachment attachment, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public void addVote(ScarabUser user) throws ScarabException, Exception(Code)(Java Doc)
public ActivitySet assignUser(ActivitySet activitySet, ScarabUser assignee, ScarabUser assigner, Attribute attribute, Attachment attachment) throws TorqueException, ScarabException(Code)(Java Doc)
protected ActivitySet attachActivitySet(ActivitySet activitySet, ScarabUser user, Attachment attachment, Integer activitySetType) throws TorqueException, ScarabException(Code)(Java Doc)
protected ActivitySet attachActivitySet(ActivitySet activitySet, ScarabUser user, Attachment attachment) throws TorqueException, ScarabException(Code)(Java Doc)
protected ActivitySet attachActivitySet(ActivitySet activitySet, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet changeUserAttributeValue(ActivitySet activitySet, ScarabUser assignee, ScarabUser assigner, AttributeValue oldAttVal, Attribute newAttr, Attachment attachment) throws TorqueException, ScarabException(Code)(Java Doc)
public boolean containsMinimumAttributeValues() throws TorqueException(Code)(Java Doc)
public void deleteIssue(ScarabUser user) throws Exception, ScarabException(Code)(Java Doc)
public void deleteItem(ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet deleteUser(ActivitySet activitySet, ScarabUser assignee, ScarabUser assigner, AttributeValue attVal, Attachment attachment) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet doAddDependency(ActivitySet activitySet, Depend depend, Issue childIssue, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet doChangeDependencyType(ActivitySet activitySet, Depend oldDepend, Depend newDepend, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet doChangeUrlDescription(ActivitySet activitySet, ScarabUser user, Attachment attachment, String oldDescription) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet doChangeUrlUrl(ActivitySet activitySet, ScarabUser user, Attachment attachment, String oldUrl) throws TorqueException, ScarabException(Code)(Java Doc)
public String doCheckAttributeValueWorkflow(HashMap newAttVals, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public String doCheckAttributeValueWorkflow(HashMap newAttVals, Attachment attachment, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public String doCheckInitialAttributeValueWorkflow(HashMap newValues, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet doDeleteDependency(ActivitySet activitySet, Depend oldDepend, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet doDeleteUrl(ActivitySet activitySet, Attachment attachment, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet doEditComment(ActivitySet activitySet, String newComment, Attachment attachment, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet doRemoveAttachment(ActivitySet activitySet, MutableBoolean physicallyDeleted, Attachment attachment, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public synchronized ActivitySet doSaveFileAttachments(ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public synchronized ActivitySet doSaveFileAttachments(ActivitySet activitySet, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public List getActivitiesWithNullEndDate(Attribute attribute) throws TorqueException(Code)(Java Doc)
public List getActivity() throws TorqueException(Code)(Java Doc)
public List getActivity(int limit) throws TorqueException(Code)(Java Doc)
public List getActivity(boolean fullHistory) throws TorqueException(Code)(Java Doc)
public ActivitySet getActivitySet(ScarabUser user, Attachment attachment, Integer type) throws TorqueException, ScarabException(Code)(Java Doc)
public ActivitySet getActivitySet(ScarabUser user, Integer type) throws TorqueException, ScarabException(Code)(Java Doc)
public List getActivitySets() throws TorqueException(Code)(Java Doc)
public Map getAllAttributeValuesMap() throws TorqueException(Code)(Java Doc)
public List getAllDependencies() throws TorqueException(Code)(Java Doc)
public List getAllDependencyTypes() throws TorqueException(Code)(Java Doc)
public Set getAllUsersToEmail(String action) throws TorqueException(Code)(Java Doc)
public HashSet getAssociatedUsers() throws TorqueException(Code)(Java Doc)
public synchronized List getAttachments() throws TorqueException(Code)(Java Doc)
public AttributeValue getAttributeValue(String attributeName) throws TorqueException(Code)(Java Doc)
public AttributeValue getAttributeValue(int id) throws TorqueException(Code)(Java Doc)
public AttributeValue getAttributeValue(Attribute attribute) throws TorqueException(Code)(Java Doc)
public List getAttributeValues(Attribute attribute) throws TorqueException(Code)(Java Doc)
public Map getAttributeValuesMap() throws TorqueException(Code)(Java Doc)
public List getBlockedIssues() throws TorqueException(Code)(Java Doc)
public List getBlockingIssues() throws TorqueException(Code)(Java Doc)
public List getChildren() throws TorqueException(Code)(Java Doc)
public List getChildren(boolean hideDeleted) throws TorqueException(Code)(Java Doc)
public List getComments(boolean full) throws TorqueException(Code)(Java Doc)
public int getCommentsCount() throws TorqueException(Code)(Java Doc)
public int getCommentsLimit() throws TorqueException(Code)(Java Doc)
public ScarabUser getCreatedBy() throws TorqueException(Code)(Java Doc)
public Date getCreatedDate() throws TorqueException(Code)(Java Doc)
public String getDefaultText() throws TorqueException(Code)(Java Doc)
public AttributeValue getDefaultTextAttributeValue() throws TorqueException(Code)(Java Doc)
public List getDependantIssues() throws TorqueException(Code)(Java Doc)
public Depend getDependency(Issue potentialDependency) throws TorqueException(Code)(Java Doc)
public Depend getDependency(Issue potentialDependency, boolean hideDeleted) throws TorqueException(Code)(Java Doc)
public List getDuplicateIssues() throws TorqueException(Code)(Java Doc)
public List getEligibleUsers(Attribute attribute) throws TorqueException, ScarabException(Code)(Java Doc)
public List getExistingAttachments() throws TorqueException(Code)(Java Doc)
public String getFederatedId() throws TorqueException(Code)(Java Doc)
public int getHistoryLimit() throws TorqueException(Code)(Java Doc)
public ActivitySet getInitialActivitySet() throws TorqueException(Code)(Java Doc)
public static Issue getIssueById(String id)(Code)(Java Doc)
public static Issue getIssueById(Issue.FederatedId fid)(Code)(Java Doc)
public String getIssueNewId() throws TorqueException(Code)(Java Doc)
public ActivitySet getLastActivitySet() throws TorqueException(Code)(Java Doc)
public List getMatchingAttributeValuesList(Module newModule, IssueType newIssueType) throws TorqueException(Code)(Java Doc)
public List getMatchingAttributeValuesList(String moduleId, String issueTypeId) throws TorqueException(Code)(Java Doc)
public ScarabUser getModifiedBy() throws TorqueException(Code)(Java Doc)
public Date getModifiedDate() throws TorqueException(Code)(Java Doc)
public Module getModule() throws TorqueException(Code)(Java Doc)
public LinkedMap getModuleAttributeValuesMap() throws TorqueException(Code)(Java Doc)
public LinkedMap getModuleAttributeValuesMap(boolean isActive) throws TorqueException(Code)(Java Doc)
public static Issue getNewInstance(Module module, IssueType issueType) throws TorqueException(Code)(Java Doc)
public List getNonMatchingAttributeValuesList(Module newModule, IssueType newIssueType) throws TorqueException(Code)(Java Doc)
public List getNonMatchingAttributeValuesList(String moduleId, String issueTypeId) throws TorqueException(Code)(Java Doc)
public List getParents() throws TorqueException(Code)(Java Doc)
public List getParents(boolean hideDeleted) throws TorqueException(Code)(Java Doc)
public List getPrerequisiteIssues() throws TorqueException(Code)(Java Doc)
public RModuleIssueType getRModuleIssueType() throws TorqueException(Code)(Java Doc)
public List getRelatedIssues() throws TorqueException(Code)(Java Doc)
public ScarabModule getScarabModule()(Code)(Java Doc)
public IssueTemplateInfo getTemplateInfo() throws TorqueException(Code)(Java Doc)
public String getUniqueId() throws TorqueException(Code)(Java Doc)
public List getUnsetRequiredAttrs(Module newModule, IssueType newIssueType) throws TorqueException(Code)(Java Doc)
public List getUrls() throws TorqueException(Code)(Java Doc)
public AttributeValue getUserAttributeValue(ScarabUser user, Attribute attribute) throws TorqueException(Code)(Java Doc)
public List getUserAttributeValues() throws TorqueException(Code)(Java Doc)
protected Set getUsersToEmail(String action, Issue issue, Set users) throws TorqueException(Code)(Java Doc)
public boolean hasEditPermission(ScarabUser user, Module module) throws TorqueException(Code)(Java Doc)
public boolean hasEnterPermission(ScarabUser user, Module module) throws TorqueException(Code)(Java Doc)
public boolean hasMovePermission(ScarabUser user, Module module) throws TorqueException(Code)(Java Doc)
public boolean isAttributeValue(AttributeValue attVal) throws TorqueException(Code)(Java Doc)
public boolean isBlocked() throws TorqueException(Code)(Java Doc)
public boolean isBlockedBy(String blockingId) throws TorqueException(Code)(Java Doc)
public boolean isBlocking(String blockedId) throws TorqueException(Code)(Java Doc)
public boolean isBlockingAnyIssue() throws TorqueException(Code)(Java Doc)
public boolean isBlockingConditionTrue() throws TorqueException(Code)(Java Doc)
public boolean isCommentsLong() throws TorqueException(Code)(Java Doc)
public boolean isCreatingUser(ScarabUser user) throws TorqueException(Code)(Java Doc)
public boolean isHistoryLong() throws TorqueException(Code)(Java Doc)
public boolean isHistoryLong(int limit) throws TorqueException(Code)(Java Doc)
public boolean isTemplate()(Code)(Java Doc)
public Issue move(Module newModule, IssueType newIssueType, String action, ScarabUser user, String reason, List commentAttrs, List commentUserValues) throws TorqueException, ScarabException(Code)(Java Doc)
public static List parseIssueList(Module module, String theList) throws TorqueException, DataSetException(Code)(Java Doc)
public void removeFile(String index) throws TorqueException(Code)(Java Doc)
public void save(Connection dbCon) throws TorqueException(Code)(Java Doc)
public ActivitySet setAttributeValues(ActivitySet activitySet, HashMap newAttVals, Attachment attachment, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public void setFederatedId(String id)(Code)(Java Doc)
public ActivitySet setInitialAttributeValues(ActivitySet activitySet, Attachment attachment, HashMap newValues, ScarabUser user) throws TorqueException, ScarabException(Code)(Java Doc)
public void setModule(Module me) throws TorqueException(Code)(Java Doc)
public void setScarabModule(ScarabModule module)(Code)(Java Doc)
public void setUniqueId(String id)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
|
|
|