org.llorllale.youtrack.api

Interface Issue

public interface Issue

A YouTrack issue.

Since:

0.1.0

Author:

George Aristy (george.aristy@gmail.com)

Method Summary

Modifier and Type	Method and Description
Comments	comments() Access to the issue's comments.
Instant	creationDate() The date the issue was created.
String	description() The issue's description.
List<AssignedField>	fields() All fields of this Issue.
String	id() The issue's id.
Project	project() The Project that the issue was created in.
Issue	refresh() Returns the same Issue after refreshing its data from the server.
String	summary() The issue's summary.
IssueTimeTracking	timetracking() Access to the issue's timetracking.
Issue	update(Field field, FieldValue value) Updates this issue's field to the given value and returns a new Issue reflecting those changes.
Issue	update(Map<Field,FieldValue> fields) Updates this issue with the fields provided, returning a new Issue reflecting those changes.
UsersOfIssue	users() Access to the issue's users.

Method Detail

project

Project project()

The Project that the issue was created in.

Returns:

the ID of the project that the issue was created in

Since:

0.4.0

id

String id()

The issue's id.

Returns:

the issue's id

Since:

0.1.0

creationDate

Instant creationDate()

The date the issue was created.

Returns:

The date the issue was created.

Since:

0.1.0

summary

String summary()

The issue's summary.

Returns:

The issue's summary.

Since:

0.1.0

description

String description()

The issue's description.

Returns:

The issue's description.

Since:

0.1.0

users

UsersOfIssue users()

Access to the issue's users.

Returns:

access to the issue's users

Since:

0.5.0

comments

Comments comments()

Access to the issue's comments.

Returns:

Access to the issue's comments.

Since:

0.4.0

timetracking

IssueTimeTracking timetracking()

Access to the issue's timetracking.

Note: it is important that you first check whether timetracking is enabled for the Project.

Returns:

access to the issue's timetracking.

Since:

0.4.0

See Also:

TimeTracking.enabled()

refresh

Issue refresh()
       throws IOException,
              UnauthorizedException

Returns the same Issue after refreshing its data from the server.

This is a convenient shortcut for issue.project().issues().get(issue.id()).get().

Returns:

the same Issue after refreshing its data from the server

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Session is not authorized to perform this operation

Since:

0.5.0

update

Issue update(Field field,
             FieldValue value)
      throws IOException,
             UnauthorizedException

Updates this issue's field to the given value and returns a new Issue reflecting those changes.

Parameters:

field - the issue's field

value - the field's value

Returns:

a new Issue reflecting the changes brought about by updating this issue with args

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Session is not authorized to perform this operation

Since:

0.7.0

See Also:

fields()

update

Issue update(Map<Field,FieldValue> fields)
      throws IOException,
             UnauthorizedException

Updates this issue with the fields provided, returning a new Issue reflecting those changes.

Parameters:

fields - the collection of fields and their values to update

Returns:

a new Issue reflecting those changes

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Session is not authorized to perform this operation

Since:

0.8.0

See Also:

update(org.llorllale.youtrack.api.Field, org.llorllale.youtrack.api.FieldValue)

fields

List<AssignedField> fields()

All fields of this Issue.

Returns:

all fields of this Issue

Since:

0.8.0

See Also:

update(org.llorllale.youtrack.api.Field, org.llorllale.youtrack.api.FieldValue)