|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IssueManager
A class to manage interactions with issues
Method Summary | |
---|---|
org.ofbiz.core.entity.GenericValue |
createIssue(String remoteUserName,
Map<String,Object> fields)
Creates an issue. |
org.ofbiz.core.entity.GenericValue |
createIssue(User remoteUser,
Issue issue)
Persists a new issue. |
org.ofbiz.core.entity.GenericValue |
createIssue(User remoteUser,
Map<String,Object> fields)
Creates an issue. |
List<org.ofbiz.core.entity.GenericValue> |
getEntitiesByIssue(String relationName,
org.ofbiz.core.entity.GenericValue issue)
Deprecated. Use getEntitiesByIssueObject(String, Issue) instead. |
List<org.ofbiz.core.entity.GenericValue> |
getEntitiesByIssueObject(String relationName,
Issue issue)
Get a list of entities (versions, components etc) related to this issue. |
org.ofbiz.core.entity.GenericValue |
getIssue(Long id)
Deprecated. Use getIssueObject(Long) instead. |
org.ofbiz.core.entity.GenericValue |
getIssue(String key)
Deprecated. Use getIssueObject(String) instead. |
org.ofbiz.core.entity.GenericValue |
getIssueByWorkflow(Long wfid)
Retrieves an issue GenericValue given a workflow ID. |
long |
getIssueCountForProject(Long projectId)
Returns the number of issues that exist for the provided project id. |
Collection<Long> |
getIssueIdsForProject(Long projectId)
Returns all issue ids for a particular project. |
MutableIssue |
getIssueObject(Long id)
Retrieves an issue by id. |
MutableIssue |
getIssueObject(String key)
Retrieves the Issue that has the given key, or null if no such Issue exists. |
MutableIssue |
getIssueObjectByWorkflow(Long workflowId)
Retrieves an issue given a workflow ID. |
List<org.ofbiz.core.entity.GenericValue> |
getIssues(Collection<Long> ids)
Get issues with the following ids. |
List<org.ofbiz.core.entity.GenericValue> |
getIssuesByEntity(String relationName,
org.ofbiz.core.entity.GenericValue entity)
Get a list of issues related to an entity (version, component etc). |
List<User> |
getIssueWatchers(org.ofbiz.core.entity.GenericValue issue)
Deprecated. Use getIssueWatchers(Issue) instead |
List<User> |
getIssueWatchers(Issue issue)
Return a list of watchers for a particular issue. |
List<org.ofbiz.core.entity.GenericValue> |
getProjectIssues(org.ofbiz.core.entity.GenericValue project)
Deprecated. only used in test cases, should use a search provider instead. |
List<Issue> |
getVotedIssues(User user)
Get a list of issues that the user has voted on and can see. |
List<Issue> |
getVotedIssuesOverrideSecurity(User user)
Get a list of issues that the user has voted on. |
List<Issue> |
getWatchedIssues(User user)
Get a list of issues that the user is watching and can see. |
List<Issue> |
getWatchedIssuesOverrideSecurity(User user)
Get a list of issues that the user is watching |
boolean |
isEditable(Issue issue)
Returns true if the issue can be edited. |
Method Detail |
---|
@Deprecated org.ofbiz.core.entity.GenericValue getIssue(Long id) throws DataAccessException
getIssueObject(Long)
instead.
id
- Issue ID.
GenericValue
.
DataAccessException
- if there is an error in the Data Access Layer.@Deprecated org.ofbiz.core.entity.GenericValue getIssue(String key) throws org.ofbiz.core.entity.GenericEntityException
getIssueObject(String)
instead.
GenericValue
with the given key.
key
- the issue key.
GenericValue
.
org.ofbiz.core.entity.GenericEntityException
- if there is a problem getting the dataorg.ofbiz.core.entity.GenericValue getIssueByWorkflow(Long wfid) throws org.ofbiz.core.entity.GenericEntityException
GenericValue
given a workflow ID. This is used when transitioning
through the various steps of a workflow.
wfid
- workflow ID.
GenericValue
.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.getIssueObjectByWorkflow(Long)
MutableIssue getIssueObjectByWorkflow(Long workflowId) throws org.ofbiz.core.entity.GenericEntityException
workflowId
- workflow ID.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.MutableIssue getIssueObject(Long id) throws DataAccessException
id
- the id
MutableIssue
DataAccessException
- if there is an error in the Data Access Layer.MutableIssue getIssueObject(String key) throws DataAccessException
Issue
that has the given key, or null if no such Issue exists.
This method will always return a new instance of an issue object if the issue exists.
key
- The Issue key.
MutableIssue
with the given key, or null if no such Issue exists.
DataAccessException
- if there is an error in the Data Access Layer.List<org.ofbiz.core.entity.GenericValue> getIssues(Collection<Long> ids)
ids
- Issue IDs.
GenericValue
sList<Issue> getVotedIssues(User user) throws org.ofbiz.core.entity.GenericEntityException
user
- The user.
Issue
objects the user has voted on.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.List<Issue> getVotedIssuesOverrideSecurity(User user) throws org.ofbiz.core.entity.GenericEntityException
user
- The user.
Issue
objects the user has voted on.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.@Deprecated List<User> getIssueWatchers(org.ofbiz.core.entity.GenericValue issue) throws org.ofbiz.core.entity.GenericEntityException, EntityNotFoundException
getIssueWatchers(Issue)
instead
issue
- the Issue.
User
s.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.
EntityNotFoundException
- Thrown when User/Group is looked up by name that does not exist.List<User> getIssueWatchers(Issue issue) throws org.ofbiz.core.entity.GenericEntityException, EntityNotFoundException
issue
- the Issue
User
s.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.
EntityNotFoundException
- Thrown when User/Group is looked up by name that does not exist.List<Issue> getWatchedIssues(User user) throws org.ofbiz.core.entity.GenericEntityException, EntityNotFoundException
user
- the User.
Issue
objects
EntityNotFoundException
- Thrown when User/Group is looked up by name that does not exist.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.List<Issue> getWatchedIssuesOverrideSecurity(User user) throws org.ofbiz.core.entity.GenericEntityException, EntityNotFoundException
user
- the User.
Issue
objects
EntityNotFoundException
- Thrown when User/Group is looked up by name that does not exist.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.@Deprecated List<org.ofbiz.core.entity.GenericValue> getEntitiesByIssue(String relationName, org.ofbiz.core.entity.GenericValue issue) throws org.ofbiz.core.entity.GenericEntityException
getEntitiesByIssueObject(String, Issue)
instead.
relationName
- A IssueRelationConstants
string indicating some issue relationissue
- Issue to consider
GenericValue
s associated with the issue.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.List<org.ofbiz.core.entity.GenericValue> getEntitiesByIssueObject(String relationName, Issue issue) throws org.ofbiz.core.entity.GenericEntityException
relationName
- A IssueRelationConstants
string indicating some issue relationissue
- Issue to consider
GenericValue
s associated with the issue.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.List<org.ofbiz.core.entity.GenericValue> getIssuesByEntity(String relationName, org.ofbiz.core.entity.GenericValue entity) throws org.ofbiz.core.entity.GenericEntityException
relationName
- A IssueRelationConstants
string indicating some relation of entityentity
- The entity related to the issues we're after
GenericValue
s associated with an entity.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.org.ofbiz.core.entity.GenericValue createIssue(String remoteUserName, Map<String,Object> fields) throws CreateException
remoteUserName
- Issue creatorfields
- A map of the issue's immediate field values. See the Issue definition in entitymodel.xml for values.
CreateException
- If JIRA is unable to create the issue.org.ofbiz.core.entity.GenericValue createIssue(User remoteUser, Map<String,Object> fields) throws CreateException
remoteUser
- Issue creatorfields
- A map of the issue's immediate field values. See the Issue definition in entitymodel.xml for values.
CreateException
- If JIRA is unable to create the issue.org.ofbiz.core.entity.GenericValue createIssue(User remoteUser, Issue issue) throws CreateException
remoteUser
- Issue creatorissue
- The new issue.
CreateException
- If JIRA is unable to create the issue.@Deprecated List<org.ofbiz.core.entity.GenericValue> getProjectIssues(org.ofbiz.core.entity.GenericValue project) throws org.ofbiz.core.entity.GenericEntityException
project
- the Project
GenericValue
objects
org.ofbiz.core.entity.GenericEntityException
- If there are errors in the persistence layer.boolean isEditable(Issue issue)
true
if the issue can be edited. This is determined by looking at the workflow step the issue is in.
issue
- the Issue.
true
if the issue can be edited. This is determined by looking at the workflow step the issue is in.Collection<Long> getIssueIdsForProject(Long projectId) throws org.ofbiz.core.entity.GenericEntityException
projectId
- Project ID.
org.ofbiz.core.entity.GenericEntityException
- An exception in the ofbiz Entity Engine.long getIssueCountForProject(Long projectId)
projectId
- identifies the project which the issues are associated with
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |