Package de.qytera.qtaf.xray.dto.jira

Class ComponentDto<U extends UserDto<?,?>>

java.lang.Object

de.qytera.qtaf.xray.dto.jira.ComponentDto<U>

Type Parameters:

U - the user type

Direct Known Subclasses:

ComponentCloudDto, ComponentServerDto

public class ComponentDto<U extends UserDto<?,?>>
extends Object

Details about a project component.

See Also:

• Get component (Jira Cloud)
• Get component (Jira Server)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ComponentDto.AssigneeType	The user type used to determine the assignee for issues created with a component.

Constructor Summary

Constructors

Constructor	Description
ComponentDto()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
U	getAssignee()	The details of the user associated with assigneeType, if any.
ComponentDto.AssigneeType	getAssigneeType()	The nominal user type used to determine the assignee for issues created with a component.
String	getDescription()	The description for the component.
String	getId()	The unique identifier for the component.
Boolean	getIsAssigneeTypeValid()	Whether a user is associated with getAssigneeType().
U	getLead()	The user details for the component's lead user.
String	getName()	The unique name for the component in the project.
String	getProject()	The key of the project the component is assigned to.
Integer	getProjectId()	The ID of the project the component is assigned to.
U	getRealAssignee()	The user assigned to issues created with this component, when getAssigneeType() does not identify a valid assignee.
ComponentDto.AssigneeType	getRealAssigneeType()	The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the getAssigneeType().
String	getSelf()	The URL of the component.
int	hashCode()
void	setAssignee(U assignee)	The details of the user associated with assigneeType, if any.
void	setAssigneeType(ComponentDto.AssigneeType assigneeType)	The nominal user type used to determine the assignee for issues created with a component.
void	setDescription(String description)	The description for the component.
void	setId(String id)	The unique identifier for the component.
void	setIsAssigneeTypeValid(Boolean isAssigneeTypeValid)	Whether a user is associated with getAssigneeType().
void	setLead(U lead)	The user details for the component's lead user.
void	setName(String name)	The unique name for the component in the project.
void	setProject(String project)	The key of the project the component is assigned to.
void	setProjectId(Integer projectId)	The ID of the project the component is assigned to.
void	setRealAssignee(U realAssignee)	The user assigned to issues created with this component, when getAssigneeType() does not identify a valid assignee.
void	setRealAssigneeType(ComponentDto.AssigneeType realAssigneeType)	The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the getAssigneeType().
void	setSelf(String self)	The URL of the component.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ComponentDto

public ComponentDto()

Method Details

getSelf

public String getSelf()

The URL of the component.

getId

public String getId()

The unique identifier for the component.

getName

public String getName()

The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.

getDescription

public String getDescription()

The description for the component. Optional when creating or updating a component.

getLead

public U getLead()

The user details for the component's lead user.

getAssigneeType

public ComponentDto.AssigneeType getAssigneeType()

The nominal user type used to determine the assignee for issues created with a component. See getRealAssigneeType() for details on how the type of the user, and hence the user, assigned to issues is determined.

getAssignee

public U getAssignee()

The details of the user associated with assigneeType, if any. See getRealAssignee() for details of the user assigned to issues created with this component.

getRealAssigneeType

public ComponentDto.AssigneeType getRealAssigneeType()

The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the getAssigneeType(). For example, getAssigneeType() is set to ComponentDto.AssigneeType.COMPONENT_LEAD but no component lead is set.

This property is set to one of the following values:

ComponentDto.AssigneeType.PROJECT_LEAD

When getAssigneeType() is ComponentDto.AssigneeType.PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in.

ComponentDto.AssigneeType.COMPONENT_LEAD

When getAssigneeType() is ComponentDto.AssigneeType.COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.

ComponentDto.AssigneeType.UNASSIGNED

When getAssigneeType() is ComponentDto.AssigneeType.UNASSIGNED and Jira is configured to allow unassigned issues.

ComponentDto.AssigneeType.PROJECT_DEFAULT

When none of the preceding cases are true.

getRealAssignee

public U getRealAssignee()

The user assigned to issues created with this component, when getAssigneeType() does not identify a valid assignee.

getIsAssigneeTypeValid

public Boolean getIsAssigneeTypeValid()

Whether a user is associated with getAssigneeType(). For example, if the type is set to ComponentDto.AssigneeType.COMPONENT_LEAD, but the component lead is not set, then false is returned.

getProject

public String getProject()

The key of the project the component is assigned to. Required when creating a component. Can't be updated.

getProjectId

public Integer getProjectId()

The ID of the project the component is assigned to.

setSelf

public void setSelf(String self)

The URL of the component.

setId

public void setId(String id)

The unique identifier for the component.

setName

public void setName(String name)

The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.

setDescription

public void setDescription(String description)

The description for the component. Optional when creating or updating a component.

setLead

public void setLead(U lead)

The user details for the component's lead user.

setAssigneeType

public void setAssigneeType(ComponentDto.AssigneeType assigneeType)

The nominal user type used to determine the assignee for issues created with a component. See getRealAssigneeType() for details on how the type of the user, and hence the user, assigned to issues is determined.

setAssignee

public void setAssignee(U assignee)

The details of the user associated with assigneeType, if any. See getRealAssignee() for details of the user assigned to issues created with this component.

setRealAssigneeType

public void setRealAssigneeType(ComponentDto.AssigneeType realAssigneeType)

The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the getAssigneeType(). For example, getAssigneeType() is set to ComponentDto.AssigneeType.COMPONENT_LEAD but no component lead is set.

This property is set to one of the following values:

ComponentDto.AssigneeType.PROJECT_LEAD

When getAssigneeType() is ComponentDto.AssigneeType.PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in.

ComponentDto.AssigneeType.COMPONENT_LEAD

When getAssigneeType() is ComponentDto.AssigneeType.COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.

ComponentDto.AssigneeType.UNASSIGNED

When getAssigneeType() is ComponentDto.AssigneeType.UNASSIGNED and Jira is configured to allow unassigned issues.

ComponentDto.AssigneeType.PROJECT_DEFAULT

When none of the preceding cases are true.

setRealAssignee

public void setRealAssignee(U realAssignee)

The user assigned to issues created with this component, when getAssigneeType() does not identify a valid assignee.

setIsAssigneeTypeValid

public void setIsAssigneeTypeValid(Boolean isAssigneeTypeValid)

Whether a user is associated with getAssigneeType(). For example, if the type is set to ComponentDto.AssigneeType.COMPONENT_LEAD, but the component lead is not set, then false is returned.

setProject

public void setProject(String project)

The key of the project the component is assigned to. Required when creating a component. Can't be updated.

setProjectId

public void setProjectId(Integer projectId)

The ID of the project the component is assigned to.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object