public interface

TimeTracking

com.atlassian.jira.functest.framework.admin.TimeTracking
Known Indirect Subclasses

Class Overview

Time tracking configuration in JIRA's Administration interface.

Summary

Nested Classes
enum TimeTracking.Format

Represents the "format" which Time Tracking information can be displayed in. 
enum TimeTracking.Mode

Represents a "mode" in which the Time Tracking module operates. 
enum TimeTracking.Unit Represnts the default unit to use for time tracking. 
Constants
String TIME_TRACKING_ADMIN_PAGE
Public Methods
void disable()

Disables Time Tracking

.
void disableCopyingOfComments()
Disables and re-enables time tracking with the "Copying of comments to work description" disabled.
void enable(TimeTracking.Format format)

Activate time tracking with default options.

void enable(String hoursPerDay, String daysPerWeek, TimeTracking.Format format, TimeTracking.Unit defaultUnit, TimeTracking.Mode mode)

Activate time tracking with non-default options.

void enable(TimeTracking.Mode mode)

Activate time tracking with default options.

void enable(String hoursPerDay, String daysPerWeek, String format, String defaultUnit, TimeTracking.Mode mode)

Activate time tracking with non-default options.

boolean isIn(TimeTracking.Mode mode)
Whether Time tracking is active in a specified mode.
void switchFormat(TimeTracking.Format format)
Short-hand for disabling and then enabling Time Tracking using the specified fromat.
void switchMode(TimeTracking.Mode mode)
Short-hand for disabling and then enabling Time Tracking into the specified mode.

Constants

public static final String TIME_TRACKING_ADMIN_PAGE

Constant Value: "/secure/admin/jira/TimeTrackingAdmin!default.jspa"

Public Methods

public void disable ()

Disables Time Tracking

.

NOTE: You need to call this before enabling Time Tracking if it is already enabled.

public void disableCopyingOfComments ()

Disables and re-enables time tracking with the "Copying of comments to work description" disabled. This will mean that when logging work on transition, the comment input will only be used for comments and not work descriptions.

public void enable (TimeTracking.Format format)

Activate time tracking with default options.

NOTE: You need to call disable() if Time Tracking is already enabled.

Parameters
format The time tracking format to be set.

public void enable (String hoursPerDay, String daysPerWeek, TimeTracking.Format format, TimeTracking.Unit defaultUnit, TimeTracking.Mode mode)

Activate time tracking with non-default options.

NOTE: You need to call disable() if Time Tracking is already enabled.

Parameters
hoursPerDay the number of hours in a day. specified as a string so you can use "5.5"
daysPerWeek the number of days in a week. specified as a string so you can use "3.5"
format the display format used ("pretty", "days", "hours")
defaultUnit default unit for time tracking entry ("minute", "hour", "day", "week")
mode The time tracking mode to be set. It can be MODERN (original estimate and remaining estimate can be edited independently), and LEGACY (original estimate can only be edited before logging work and after that you can only edit the remaining estimate).

public void enable (TimeTracking.Mode mode)

Activate time tracking with default options.

NOTE: You need to call disable() if Time Tracking is already enabled.

Parameters
mode The time tracking mode to be set.

public void enable (String hoursPerDay, String daysPerWeek, String format, String defaultUnit, TimeTracking.Mode mode)

Activate time tracking with non-default options.

NOTE: You need to call disable() if Time Tracking is already enabled.

Parameters
hoursPerDay the number of hours in a day. specified as a string so you can use "5.5"
daysPerWeek the number of days in a week. specified as a string so you can use "3.5"
format the display format used ("pretty", "days", "hours")
defaultUnit default unit for time tracking entry ("minute", "hour", "day", "week")
mode The time tracking mode to be set. It can be MODERN (original estimate and remaining estimate can be edited independently), and LEGACY (original estimate can only be edited before logging work and after that you can only edit the remaining estimate).

public boolean isIn (TimeTracking.Mode mode)

Whether Time tracking is active in a specified mode.

NOTE: If time tracking is disabled this method will return false.

Parameters
mode The mode to check.
Returns
  • true if time tracking is on in the specified mode; otherwise, it returns false.

public void switchFormat (TimeTracking.Format format)

Short-hand for disabling and then enabling Time Tracking using the specified fromat.

Parameters
format the fromat to enable.

public void switchMode (TimeTracking.Mode mode)

Short-hand for disabling and then enabling Time Tracking into the specified mode.

Parameters
mode the mode to enable.