org.llorllale.youtrack.api

Interface IssueTimeTracking

public interface IssueTimeTracking

API for Issue timetracking.

Note: timetracking needs to be enabled for the Project in YouTrack, otherwise these operations will throw IOException.

Since:

0.4.0

Author:

George Aristy (george.aristy@gmail.com)

Method Summary

Modifier and Type	Method and Description
IssueTimeTracking	create(Duration duration) Creates a new entry with all other fields unspecified.
IssueTimeTracking	create(Duration duration, String description) Creates a new entry with a duration and description.
IssueTimeTracking	create(Duration duration, String description, TimeTrackEntryType type) Creates a new entry with a duration, description, and a type.
IssueTimeTracking	create(Duration duration, TimeTrackEntryType type) Creates a new entry with a duration and a type.
IssueTimeTracking	create(LocalDate date, Duration duration) Creates a new entry with a duration and a date.
IssueTimeTracking	create(LocalDate date, Duration duration, String description) Creates a new entry with a duration, date, and description.
IssueTimeTracking	create(LocalDate date, Duration duration, String description, TimeTrackEntryType type) Creates a new entry.
Stream<TimeTrackEntry>	stream() Returns a Stream with all available work entries for the Issue.

Method Detail

stream

Stream<TimeTrackEntry> stream()
                       throws IOException,
                              UnauthorizedException

Returns a Stream with all available work entries for the Issue.

Returns:

a Stream with all available work entries for the Issue

Throws:

IOException - if the server is unavailable

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

Since:

0.4.0

create

IssueTimeTracking create(LocalDate date,
                         Duration duration,
                         String description,
                         TimeTrackEntryType type)
                  throws IOException,
                         UnauthorizedException

Creates a new entry.

Parameters:

date - the date when the entry was worked

duration - the work's duration

description - description for the work entry

type - the work type (eg. "Development")

Returns:

IssueTimeTracking

Throws:

IOException - if the server is unavailable

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

Since:

1.0.0

create

IssueTimeTracking create(Duration duration)
                  throws IOException,
                         UnauthorizedException

Creates a new entry with all other fields unspecified.

Parameters:

duration - the work's duration

Returns:

IssueTimeTracking

Throws:

IOException - if the server is unavailable

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

Since:

1.0.0

create

IssueTimeTracking create(Duration duration,
                         String description)
                  throws IOException,
                         UnauthorizedException

Creates a new entry with a duration and description.

Parameters:

duration - the work's duration

description - descriptive text

Returns:

IssueTimeTracking

Throws:

IOException - if the server is unavailable

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

Since:

1.0.0

create

IssueTimeTracking create(LocalDate date,
                         Duration duration)
                  throws IOException,
                         UnauthorizedException

Creates a new entry with a duration and a date.

Parameters:

date - the date when the entry was worked

duration - the work's duration

Returns:

IssueTimeTracking

Throws:

IOException - if the server is unavailable

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

Since:

1.0.0

create

IssueTimeTracking create(Duration duration,
                         TimeTrackEntryType type)
                  throws IOException,
                         UnauthorizedException

Creates a new entry with a duration and a type.

Parameters:

duration - the work's duration

type - the work type (eg. "Development")

Returns:

IssueTimeTracking

Throws:

IOException - if the server is unavailable

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

Since:

1.0.0

create

IssueTimeTracking create(Duration duration,
                         String description,
                         TimeTrackEntryType type)
                  throws IOException,
                         UnauthorizedException

Creates a new entry with a duration, description, and a type.

Parameters:

duration - the work's duration

description - descriptive text

type - the work type (eg. "Development")

Returns:

IssueTimeTracking

Throws:

IOException - if the server is unavailable

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

Since:

1.0.0

create

IssueTimeTracking create(LocalDate date,
                         Duration duration,
                         String description)
                  throws IOException,
                         UnauthorizedException

Creates a new entry with a duration, date, and description.

Parameters:

date - the date when the entry was worked

duration - the work's duration

description - descriptive text

Returns:

IssueTimeTracking

Throws:

IOException - if the server is unavailable

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

Since:

1.0.0