org.llorllale.youtrack.api

Interface UpdateIssue

public interface UpdateIssue

API to update an Issue.

Since:

0.9.0

Author:

George Aristy (george.aristy@gmail.com)

Method Summary

Modifier and Type	Method and Description
Issue	description(String description) Updates the issue's description.
Issue	field(Field field, FieldValue value) Updates the issue's field to the given value and returns a new Issue reflecting those changes.
Issue	fields(Map<Field,FieldValue> fields) Updates this issue with the fields provided, returning a new Issue reflecting those changes.
Issue	summary(String summary) Updates the issue's summary.
Issue	summaryAndDesc(String summary, String description) Updates the issue's summary and description.

Method Detail

summary

Issue summary(String summary)
       throws IOException,
              UnauthorizedException

Updates the issue's summary.

Parameters:

summary - the new text for the issue's summary

Returns:

a new instance of the Issue reflecting the changes

Throws:

IOException - if the server is unavailable

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

Since:

0.9.0

description

Issue description(String description)
           throws IOException,
                  UnauthorizedException

Updates the issue's description.

Parameters:

description - the new text for the issue's description

Returns:

a new instance of the Issue reflecting the changes

Throws:

IOException - if the server is unavailable

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

Since:

0.9.0

summaryAndDesc

Issue summaryAndDesc(String summary,
                     String description)
              throws IOException,
                     UnauthorizedException

Updates the issue's summary and description.

Parameters:

summary - the new text for the issue's summary

description - the new text for the issue's description

Returns:

a new instance of the Issue reflecting the changes

Throws:

IOException - if the server is unavailable

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

Since:

0.9.0

field

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

Updates the 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 instance of the Issue reflecting the changes

Throws:

IOException - if the server is unavailable

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

Since:

0.9.0

See Also:

Issue.fields()

fields

Issue fields(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 instance of the Issue reflecting the changes

Throws:

IOException - if the server is unavailable

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

Since:

0.9.0