org.llorllale.youtrack.api

Interface ProjectTimeTracking

public interface ProjectTimeTracking

Access to a project's timetracking settings.

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

Since:

0.8.0

Author:

George Aristy (george.aristy@gmail.com)

See Also:

Issue.timetracking()

Method Summary

Modifier and Type	Method and Description
boolean	enabled() Whether timetracking is enabled for the Project or not.
Project	project() The parent Project.
Stream<TimeTrackEntryType>	types() A stream of all timetracking entry types, if timetracking is enabled.

Method Detail

project

Project project()

The parent Project.

Returns:

the parent Project

Since:

0.8.0

enabled

boolean enabled()
         throws IOException,
                UnauthorizedException

Whether timetracking is enabled for the Project or not.

The determination is made by making sure that all these conditions are met:

• Timetracking is enabled for the project
• An estimation field has been configured
• A "time spent" field has been configured

Returns:

true if timetracking is enabled for the Project according to the rules above, false otherwise

Throws:

IOException - if the server is unavailable

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

Since:

0.8.0

types

Stream<TimeTrackEntryType> types()
                          throws IOException,
                                 UnauthorizedException

A stream of all timetracking entry types, if timetracking is enabled.

Returns:

a stream of all timetracking entry types

Throws:

IOException - if the server is unavailable, or if timetracking is not enabled for this Project

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

Since:

0.8.0