|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.torque.om.BaseObject
org.tigris.scarab.om.BaseIssue
org.tigris.scarab.om.Issue
This class represents an Issue.
| Nested Class Summary | |
static class |
Issue.FederatedId
A FederatedId has this format: {Domain}-{Code}{Id} For example: collab.net-PACS1 The domain can also be null. |
| Field Summary | |
protected static java.lang.String |
GET_ACTIVITY
|
protected static java.lang.String |
GET_ALL_DEPENDENCY_TYPES
|
protected static java.lang.String |
GET_ALL_USERS_TO_EMAIL
|
protected static java.lang.String |
GET_ASSOCIATED_USERS
|
protected static java.lang.String |
GET_ATTRIBUTE_VALUES_MAP
|
protected static java.lang.String |
GET_ATTRVALUE
|
protected static java.lang.String |
GET_ATTRVALUES
|
protected static java.lang.String |
GET_CHILDREN
|
protected static java.lang.String |
GET_CLOSED_DATE
|
protected static java.lang.String |
GET_COMMENTS
|
protected static java.lang.String |
GET_CREATED_BY
|
protected static java.lang.String |
GET_CREATED_DATE
|
protected static java.lang.String |
GET_DEFAULT_TEXT
|
protected static java.lang.String |
GET_DEFAULT_TEXT_ATTRIBUTEVALUE
|
protected static java.lang.String |
GET_DEPENDENCY
|
protected static java.lang.String |
GET_EXISTING_ATTACHMENTS
|
protected static java.lang.String |
GET_HISTORY_LIMIT
|
protected static java.lang.String |
GET_INITIAL_ACTIVITYSET
|
protected static java.lang.String |
GET_LAST_TRANSACTION
|
protected static java.lang.String |
GET_MODIFIED_BY
|
protected static java.lang.String |
GET_MODIFIED_DATE
|
protected static java.lang.String |
GET_MODULE_ATTRVALUES_MAP
|
protected static java.lang.String |
GET_NULL_END_DATE
|
protected static java.lang.String |
GET_ORPHAN_ATTRIBUTEVALUES_LIST
|
protected static java.lang.String |
GET_PARENTS
|
protected static java.lang.String |
GET_TEMPLATE_TYPES
|
protected static java.lang.String |
GET_TEMPLATEINFO
|
protected static java.lang.String |
GET_TRANSACTIONS
|
protected static java.lang.String |
GET_URLS
|
protected static java.lang.String |
GET_USER_ATTRIBUTEVALUE
|
protected static java.lang.String |
GET_USER_ATTRIBUTEVALUES
|
| Fields inherited from class org.tigris.scarab.om.BaseIssue |
collActivitys, collAttachments, collAttributeValues, collDependsRelatedByObservedId, collDependsRelatedByObserverId, collIssueTemplateInfos, collIssueVotes |
| Fields inherited from class org.apache.torque.om.BaseObject |
NEW_ID |
| Constructor Summary | |
protected |
Issue()
new issues are created only when the issuetype and module are known Or by the Peer when retrieving from db |
protected |
Issue(Module module,
IssueType issueType)
|
| Method Summary | |
void |
addActivity(Activity activity)
Returns limited list of Activity objects associated with this Issue. |
void |
addAttributeValue(AttributeValue aval)
Method called to associate a AttributeValue object to this object through the AttributeValue foreign key attribute |
ActivitySet |
addComment(ActivitySet activitySet,
Attachment attachment,
ScarabUser user)
Adds a comment to an issue. |
ActivitySet |
addComment(Attachment attachment,
ScarabUser user)
Adds a comment to an issue and passes null as the activity set to create a new one. |
void |
addFile(Attachment attachment,
ScarabUser user)
Adds an attachment file to this issue. |
ActivitySet |
addUrl(ActivitySet activitySet,
Attachment attachment,
ScarabUser user)
Adds a url to an issue. |
ActivitySet |
addUrl(Attachment attachment,
ScarabUser user)
Adds a url to an issue and passes null as the activity set to create a new one. |
void |
addVote(ScarabUser user)
|
ActivitySet |
assignUser(ActivitySet activitySet,
ScarabUser assignee,
ScarabUser assigner,
Attribute attribute,
Attachment attachment)
Assigns user to issue. |
protected ActivitySet |
attachActivitySet(ActivitySet activitySet,
ScarabUser user)
|
protected ActivitySet |
attachActivitySet(ActivitySet activitySet,
ScarabUser user,
Attachment attachment)
|
protected ActivitySet |
attachActivitySet(ActivitySet activitySet,
ScarabUser user,
Attachment attachment,
java.lang.Integer activitySetType)
Sets an ActivitySet as the lastActivitySet of an Issue. |
ActivitySet |
changeUserAttributeValue(ActivitySet activitySet,
ScarabUser assignee,
ScarabUser assigner,
AttributeValue oldAttVal,
Attribute newAttr,
Attachment attachment)
Used to change a user attribute value from one user attribute to a new one. |
boolean |
containsMinimumAttributeValues()
Describe containsMinimumAttributeValues method here. |
void |
deleteIssue(ScarabUser user)
If the user has permission to delete ISSUES in this module, it wil mark this issue as DELETED. |
void |
deleteItem(ScarabUser user)
Checks if user has permission to delete issue template. |
ActivitySet |
deleteUser(ActivitySet activitySet,
ScarabUser assignee,
ScarabUser assigner,
AttributeValue attVal,
Attachment attachment)
Used to delete a user attribute value. |
ActivitySet |
doAddDependency(ActivitySet activitySet,
Depend depend,
Issue childIssue,
ScarabUser user)
|
ActivitySet |
doChangeDependencyType(ActivitySet activitySet,
Depend oldDepend,
Depend newDepend,
ScarabUser user)
changes the dependency type as well as. will not change deptype for deleted deps |
ActivitySet |
doChangeUrlDescription(ActivitySet activitySet,
ScarabUser user,
Attachment attachment,
java.lang.String oldDescription)
Given a specific attachment object allow us to update the information in it. |
ActivitySet |
doChangeUrlUrl(ActivitySet activitySet,
ScarabUser user,
Attachment attachment,
java.lang.String oldUrl)
Given a specific attachment object allow us to update the information in it. |
java.lang.String |
doCheckAttributeValueWorkflow(java.util.HashMap newAttVals,
Attachment attachment,
ScarabUser user)
Deprecated. The attachment doesn't need to be passed into this method. |
java.lang.String |
doCheckAttributeValueWorkflow(java.util.HashMap newAttVals,
ScarabUser user)
This method is used with the setAttributeValues() method to Make sure that workflow is valid. |
java.lang.String |
doCheckInitialAttributeValueWorkflow(java.util.HashMap newValues,
ScarabUser user)
This method is used with the setInitialAttributeValues() method to Make sure that workflow is valid for the initial values of a new issue. |
ActivitySet |
doDeleteDependency(ActivitySet activitySet,
Depend oldDepend,
ScarabUser user)
Deletes a specific dependency on this issue. |
ActivitySet |
doDeleteUrl(ActivitySet activitySet,
Attachment attachment,
ScarabUser user)
If the URL hasn't changed, it will return a valid ActivitySet otherwise it returns null. |
ActivitySet |
doEditComment(ActivitySet activitySet,
java.lang.String newComment,
Attachment attachment,
ScarabUser user)
If the comment hasn't changed, it will return a valid ActivitySet otherwise it returns null. |
ActivitySet |
doRemoveAttachment(ActivitySet activitySet,
MutableBoolean physicallyDeleted,
Attachment attachment,
ScarabUser user)
Remove the attachment. |
ActivitySet |
doSaveFileAttachments(ActivitySet activitySet,
ScarabUser user)
Adds an attachment file to this issue. |
ActivitySet |
doSaveFileAttachments(ScarabUser user)
Adds an attachment file to this issue. |
java.util.List |
getActivitiesWithNullEndDate(Attribute attribute)
|
java.util.List |
getActivity()
Returns list of Activity objects associated with this Issue. |
java.util.List |
getActivity(boolean fullHistory)
Returns limited list of Activity objects associated with this Issue. |
java.util.List |
getActivity(int limit)
Returns limited list of Activity objects associated with this Issue. |
ActivitySet |
getActivitySet(ScarabUser user,
Attachment attachment,
java.lang.Integer type)
Creates a new ActivitySet object for the issue. |
ActivitySet |
getActivitySet(ScarabUser user,
java.lang.Integer type)
Creates a new ActivitySet object for the issue. |
java.util.List |
getActivitySets()
Returns a list of ActivitySet objects associated to this issue. |
java.util.Map |
getAllAttributeValuesMap()
AttributeValues that are set for this issue and Empty AttributeValues that are relevant for the module, but have not been set for the issue are included. |
java.util.List |
getAllDependencies()
Returns the combined output from getChildren() and getParents() |
java.util.List |
getAllDependencyTypes()
Deprecated. use DependencyTypeManager.getAll(); |
java.util.Set |
getAllUsersToEmail(java.lang.String action)
Returns users assigned to user attributes that get emailed When issue is modified. |
java.util.HashSet |
getAssociatedUsers()
Returns users assigned to all user attributes. |
java.util.List |
getAttachments()
Overrides the super method in order to allow us to return the unSavedAttachments if they exist. |
AttributeValue |
getAttributeValue(Attribute attribute)
|
AttributeValue |
getAttributeValue(int id)
|
AttributeValue |
getAttributeValue(java.lang.String attributeName)
|
java.util.List |
getAttributeValues(Attribute attribute)
Returns the (undeleted) AttributeValues for the Attribute. |
java.util.Map |
getAttributeValuesMap()
AttributeValues that are set for this Issue |
java.util.List |
getBlockedIssues()
Returns a list of issues currently BLOCKED by this issue |
java.util.List |
getBlockingIssues()
Returns a list of issues that actually "block" this issue, i.e., that are related via a "is blocked by" dependency, and are "blocking". |
java.util.List |
getChildren()
Returns list of child dependencies i.e., related to this issue through the DEPEND table. |
java.util.List |
getChildren(boolean hideDeleted)
Returns list of child dependencies i.e., related to this issue through the DEPEND table. |
java.util.List |
getComments(boolean full)
Returns a list of Attachment objects with type "Comment" That are associated with this issue. |
int |
getCommentsCount()
Returns the total number of comments. |
int |
getCommentsLimit()
Gets default comments limit for this module-issue type. |
ScarabUser |
getCreatedBy()
The user that created the issue. |
java.util.Date |
getCreatedDate()
The date the issue was created. |
java.lang.String |
getDefaultText()
This calls getDefaultTextAttributeValue() and then returns the String value of the Attribute. |
AttributeValue |
getDefaultTextAttributeValue()
This method will return the AttributeValue which represents the default text attribute. |
java.util.List |
getDependantIssues()
Returns a list of issues that might be blocked by this issue because if its "is_blocked_by" dependency. |
Depend |
getDependency(Issue potentialDependency)
Checks to see if this issue has a dependency on the passed in issue. |
Depend |
getDependency(Issue potentialDependency,
boolean hideDeleted)
Checks to see if this issue has a dependency on the passed in issue. |
java.util.List |
getDuplicateIssues()
Returns a list of issues that are related to this issue, via a "is_duplicate of" relationship. |
java.util.List |
getEligibleUsers(Attribute attribute)
Users who are valid values to the attribute this issue. |
java.util.List |
getExistingAttachments()
Get attachments that are not deleted |
java.lang.String |
getFederatedId()
|
int |
getHistoryLimit()
Gets default history limit for this module-issue type. |
ActivitySet |
getInitialActivitySet()
The initial activity set from issue creation. |
static Issue |
getIssueById(Issue.FederatedId fid)
Deprecated. use IssueManager.getIssueById |
static Issue |
getIssueById(java.lang.String id)
Deprecated. use IssueManager.getIssueById |
java.lang.String |
getIssueNewId()
This method search for the new ID of a moved issue. |
ActivitySet |
getLastActivitySet()
The last modification made to the issue. |
java.util.List |
getMatchingAttributeValuesList(Module newModule,
IssueType newIssueType)
Gets a list of non-user AttributeValues which match a given Module. |
java.util.List |
getMatchingAttributeValuesList(java.lang.String moduleId,
java.lang.String issueTypeId)
|
ScarabUser |
getModifiedBy()
The last user to modify the issue. |
java.util.Date |
getModifiedDate()
The date issue was last modified. |
Module |
getModule()
Module getter. |
org.apache.commons.collections.map.LinkedMap |
getModuleAttributeValuesMap()
Calls the overloaded version by passing 'true' so that only active attributes will be considered. |
org.apache.commons.collections.map.LinkedMap |
getModuleAttributeValuesMap(boolean isActive)
AttributeValues that are relevant to the issue's current module. |
static Issue |
getNewInstance(Module module,
IssueType issueType)
Gets an issue associated to a Module |
java.util.List |
getNonMatchingAttributeValuesList(Module newModule,
IssueType newIssueType)
Gets a list AttributeValues which the source module has, But the destination module does not have, when doing a copy. |
java.util.List |
getNonMatchingAttributeValuesList(java.lang.String moduleId,
java.lang.String issueTypeId)
|
java.util.List |
getParents()
Returns list of parent dependencies i.e., related to this issue through the DEPEND table. |
java.util.List |
getParents(boolean hideDeleted)
Returns list of parent dependencies i.e., related to this issue through the DEPEND table. |
java.util.List |
getPrerequisiteIssues()
Returns a list of issues that are blockable by this issue, via a "is_blocked_by" relationship. |
java.util.List |
getRelatedIssues()
Returns a list of issues that are related to this issue, via a "is_related to" relationship. |
RModuleIssueType |
getRModuleIssueType()
The RModuleIssueType related to this issue's module and issue type. |
ScarabModule |
getScarabModule()
Throws UnsupportedOperationException. |
IssueTemplateInfo |
getTemplateInfo()
Get IssueTemplateInfo by Issue Id. |
java.lang.String |
getUniqueId()
Gets the UniqueId for this Issue. |
java.util.List |
getUnsetRequiredAttrs(Module newModule,
IssueType newIssueType)
Get Unset required attributes in destination module / issue type. |
java.util.List |
getUrls()
Returns a list of Attachment objects with type "URL" That are associated with this issue. |
AttributeValue |
getUserAttributeValue(ScarabUser user,
Attribute attribute)
Returns the specific user's attribute value. |
java.util.List |
getUserAttributeValues()
Returns attribute values for user attributes. |
protected java.util.Set |
getUsersToEmail(java.lang.String action,
Issue issue,
java.util.Set users)
Returns the users which should be notified when this issue is modified. |
boolean |
hasEditPermission(ScarabUser user,
Module module)
Deprecated. user.hasPermission(ScarabSecurity.ISSUE__EDIT, module) |
boolean |
hasEnterPermission(ScarabUser user,
Module module)
Deprecated. user.hasPermission(ScarabSecurity.ISSUE__ENTER, module) |
boolean |
hasMovePermission(ScarabUser user,
Module module)
Deprecated. user.hasPermission(ScarabSecurity.ISSUE__EDIT, module) |
boolean |
isAttributeValue(AttributeValue attVal)
|
boolean |
isBlocked()
An issue is blocked when it depends, via a is_blocked_by dependency, of an issue that is currently "blocking". |
boolean |
isBlockedBy(java.lang.String blockingId)
An issue is blocked when it depends, via a is_blocked_by dependency, of an issue that is currently "blocking". |
boolean |
isBlocking(java.lang.String blockedId)
|
boolean |
isBlockingAnyIssue()
Returns if this issue is currently blocking any other. |
boolean |
isBlockingConditionTrue()
Returns if the issue's BlockingCondition is fulfilled. |
boolean |
isCommentsLong()
Determines whether the comments list is longer than The default limit. |
boolean |
isCreatingUser(ScarabUser user)
|
boolean |
isHistoryLong()
Determines whether the history list is longer than The default limit. |
boolean |
isHistoryLong(int limit)
Determines whether the history list is longer than The limit. |
boolean |
isTemplate()
Whether this issue is an enter issue template. |
Issue |
move(Module newModule,
IssueType newIssueType,
java.lang.String action,
ScarabUser user,
java.lang.String reason,
java.util.List commentAttrs,
java.util.List commentUserValues)
Move or copy issue to destination module. |
static java.util.List |
parseIssueList(Module module,
java.lang.String theList)
|
void |
removeFile(java.lang.String index)
Remove an attachment file |
void |
save(java.sql.Connection dbCon)
Removes any unset attributes and sets the issue # prior to saving for the first time. |
ActivitySet |
setAttributeValues(ActivitySet activitySet,
java.util.HashMap newAttVals,
Attachment attachment,
ScarabUser user)
Sets AttributeValues for an issue based on a hashmap of attribute values This is data is saved to the database and the proper ActivitySet is also recorded. |
void |
setFederatedId(java.lang.String id)
|
ActivitySet |
setInitialAttributeValues(ActivitySet activitySet,
Attachment attachment,
java.util.HashMap newValues,
ScarabUser user)
Sets original AttributeValues for an new issue based on a hashmap of values This is data is saved to the database and the proper ActivitySet is also recorded. |
void |
setModule(Module me)
Use this instead of setScarabModule. |
void |
setScarabModule(ScarabModule module)
Throws UnsupportedOperationException. |
void |
setUniqueId(java.lang.String id)
NoOp for intake's benefit |
java.lang.String |
toString()
|
| Methods inherited from class org.apache.torque.om.BaseObject |
equals, equals, getLog, hashCode, isModified, isNew, resetModified, setModified, setNew, setPrimaryKey |
| Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.apache.torque.om.Persistent |
getPrimaryKey, isModified, isNew, save, save, setModified, setNew, setPrimaryKey, setPrimaryKey |
| Field Detail |
protected static final java.lang.String GET_ATTRIBUTE_VALUES_MAP
protected static final java.lang.String GET_ASSOCIATED_USERS
protected static final java.lang.String GET_MODULE_ATTRVALUES_MAP
protected static final java.lang.String GET_ATTRVALUE
protected static final java.lang.String GET_ATTRVALUES
protected static final java.lang.String GET_ALL_USERS_TO_EMAIL
protected static final java.lang.String GET_USER_ATTRIBUTEVALUE
protected static final java.lang.String GET_USER_ATTRIBUTEVALUES
protected static final java.lang.String GET_CREATED_DATE
protected static final java.lang.String GET_CREATED_BY
protected static final java.lang.String GET_LAST_TRANSACTION
protected static final java.lang.String GET_MODIFIED_BY
protected static final java.lang.String GET_MODIFIED_DATE
protected static final java.lang.String GET_COMMENTS
protected static final java.lang.String GET_URLS
protected static final java.lang.String GET_EXISTING_ATTACHMENTS
protected static final java.lang.String GET_ACTIVITY
protected static final java.lang.String GET_TRANSACTIONS
protected static final java.lang.String GET_CHILDREN
protected static final java.lang.String GET_PARENTS
protected static final java.lang.String GET_ALL_DEPENDENCY_TYPES
protected static final java.lang.String GET_DEPENDENCY
protected static final java.lang.String GET_TEMPLATE_TYPES
protected static final java.lang.String GET_TEMPLATEINFO
protected static final java.lang.String GET_CLOSED_DATE
protected static final java.lang.String GET_ORPHAN_ATTRIBUTEVALUES_LIST
protected static final java.lang.String GET_DEFAULT_TEXT_ATTRIBUTEVALUE
protected static final java.lang.String GET_DEFAULT_TEXT
protected static final java.lang.String GET_NULL_END_DATE
protected static final java.lang.String GET_INITIAL_ACTIVITYSET
protected static final java.lang.String GET_HISTORY_LIMIT
| Constructor Detail |
protected Issue()
protected Issue(Module module,
IssueType issueType)
throws org.apache.torque.TorqueException
| Method Detail |
public static Issue getNewInstance(Module module,
IssueType issueType)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueExceptionpublic static Issue getIssueById(java.lang.String id)
public static Issue getIssueById(Issue.FederatedId fid)
public java.lang.String getUniqueId()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueExceptionpublic void setUniqueId(java.lang.String id)
public java.lang.String getFederatedId()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueExceptionpublic void setFederatedId(java.lang.String id)
public static java.util.List parseIssueList(Module module,
java.lang.String theList)
throws org.apache.torque.TorqueException,
com.workingdogs.village.DataSetException
module - The current module.theList - A textual representation of the list of issues
to parse.
org.apache.torque.TorqueException
com.workingdogs.village.DataSetExceptionpublic boolean isTemplate()
public ActivitySet addUrl(Attachment attachment,
ScarabUser user)
throws org.apache.torque.TorqueException,
ScarabException
org.apache.torque.TorqueException
ScarabException
public ActivitySet addUrl(ActivitySet activitySet,
Attachment attachment,
ScarabUser user)
throws org.apache.torque.TorqueException,
ScarabException
org.apache.torque.TorqueException
ScarabException
public ActivitySet addComment(Attachment attachment,
ScarabUser user)
throws org.apache.torque.TorqueException,
ScarabException
org.apache.torque.TorqueException
ScarabExceptionpublic