com.atlassian.jira.functest.framework.admin

Interface TimeTracking

All Known Implementing Classes:

TimeTrackingImpl

public interface TimeTracking

Time tracking configuration in JIRA's Administration interface.

Since:

v4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TimeTracking.Format Represents the "format" which Time Tracking information can be displayed in.
static class	TimeTracking.Mode Represents a "mode" in which the Time Tracking module operates.
static class	TimeTracking.Unit Represnts the default unit to use for time tracking.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TIME_TRACKING_ADMIN_PAGE

Method Summary

Modifier and Type	Method and Description
void	disable() Disables Time Tracking
void	disableCopyingOfComments() Disables and re-enables time tracking with the "Copying of comments to work description" disabled.
void	enable(String hoursPerDay, String daysPerWeek, String format, String defaultUnit, TimeTracking.Mode mode) Activate time tracking with non-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.Format format) Activate time tracking with default options.
void	enable(TimeTracking.Mode mode) Activate time tracking with 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.

Field Detail

TIME_TRACKING_ADMIN_PAGE

static final String TIME_TRACKING_ADMIN_PAGE

See Also:

Constant Field Values

Method Detail

enable

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.

switchMode

void switchMode(TimeTracking.Mode mode)

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

Parameters:

mode - the mode to enable.

enable

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.

disable

void disable()

Disables Time Tracking

.

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

enable

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).

enable

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).

isIn

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.

disableCopyingOfComments

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.

Since:

v4.2

switchFormat

void switchFormat(TimeTracking.Format format)

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

Parameters:

format - the fromat to enable.