PeriodProjectCustomField

Represents a custom field in a project that stores a value as a period type. We use org.joda.time.Period as a base class for period values. While you can read the class documentation at http://joda-time.sourceforge.net/apidocs/org/joda/time/Period.html, please note that we support only class members which use the Period class and primitive types like String and int.

Extends SimpleProjectCustomField.

// to convert period to minutes (or other units) use get* methods:
var period = issue.fields.Estimation;
var minutes = !period ? 0 : (period.getMinutes() +
                             60 * (period.getHours() +
                                   8 * period.getDays()));
// to create Period instance, use toPeriod function from date-time module:
issue.fields.Estimation = dateTime.toPeriod(3 * 3600 * 1000); // 3h in ms
issue.fields.Estimation = dateTime.toPeriod('3h'); // short form
issue.fields.Estimation = dateTime.toPeriod('2w4d3h15m'); // full form

Properties

Name	Type	Description
becomesRemoved	`Boolean`	When `true`, the entity is removed in the current transaction. Otherwise, `false`. Available since 2017.4.37915
isNew	`Boolean`	When `true`, the entity is created in the current transaction. Otherwise, `false`. Available since 2018.2.42351
localizedName	`String`	The localized name of the field.
name	`String`	The name of the field.
nullValueText	`String`	The text that is displayed for this field when it is empty.

Methods

becomes

becomes(fieldName, expected)

Checks whether a field is set to an expected value in the current transaction.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field to check.
expected	`string`	The expected value.

Return Value

	Type	Description
	`boolean`	If the field is set to the expected value, returns `true`.

becomesInvisibleInIssue

becomesInvisibleInIssue(issue)

Checks if the changes that are applied in the current transaction remove the condition to show the custom field.

Available since 2018.2.42312

Parameters

Name	Type	Description
issue	`Issue`	The issue for which the condition for showing the field is checked.

Return Value

	Type	Description
	`Boolean`	When `true`, the condition for showing the field is removed in the current transaction.

becomesVisibleInIssue

becomesVisibleInIssue(issue)

Checks if the changes that are applied in the current transaction satisfy the condition to show the custom field.

Available since 2018.2.42312

Parameters

Name	Type	Description
issue	`Issue`	The issue for which the condition for showing the field is checked.

Return Value

	Type	Description
	`Boolean`	When `true`, the condition for showing the field is met in the current transaction.

canBeReadBy

canBeReadBy(fieldName, user)

Checks whether a user has permission to read the field.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field.
user	`User`	The user for whom the permission to read the field is checked.

Return Value

	Type	Description
	`boolean`	If the user can read the field, returns `true`.

canBeWrittenBy

canBeWrittenBy(fieldName, user)

Checks whether a user has permission to update the field.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field.
user	`User`	The user for whom the permission to update the field is checked.

Return Value

	Type	Description
	`boolean`	If the user can update the field, returns `true`.

getBackgroundColor

getBackgroundColor(issue)

Returns the background color that is used for this field value in the specified issue. Can return `null`, `"white"`, or a hex color presentation.

Parameters

Name	Type	Description
issue	`Issue`	The issue for which the background color is returned.

Return Value

	Type	Description
	`String`	The background color that is used for this field value in the specified issue.

getForegroundColor

getForegroundColor(issue)

Returns the foreground color that is used for this field value in the specified issue. Can return `null`, `"white"`, or a hex color presentation.

Parameters

Name	Type	Description
issue	`Issue`	The issue for which the foreground color is returned.

Return Value

	Type	Description
	`String`	The foreground color that is used for this field value in the specified issue.

getValuePresentation

getValuePresentation(issue)

Returns the string presentation of the value that is stored in this field in the specified issue.

Parameters

Name	Type	Description
issue	`Issue`	The issue for which the value presentation is returned.

Return Value

	Type	Description
	`String`	The string presentation of the value.

isChanged

isChanged(fieldName)

Checks whether the value of a field is changed in the current transaction.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field to check.

Return Value

	Type	Description
	`boolean`	If the value of the field is changed in the current transaction, returns `true`.

isVisibleInIssue

isVisibleInIssue(issue)

Checks if a field is visible in the issue.

Available since 2018.2.42312

Parameters

Name	Type	Description
issue	`Issue`	The issue for which the condition for showing the field is checked.

Return Value

	Type	Description
	`Boolean`	When `true`, the condition for showing the custom field in the issue has been met. It can also mean that the field is not shown on a conditional basis and is always visible.

oldValue

oldValue(fieldName)

Returns the previous value of a single-value field before an update was applied. If the field is not changed in the transaction, returns null.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field.

Return Value

	Type	Description
	`Object`	If the field is changed in the current transaction, the previous value of the field. Otherwise, null.

required

required(fieldName, message)

Asserts that a value is set for a field. If a value for the required field is not set, the specified message is displayed in the user interface.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field to check.
message	`string`	The message that is displayed to the user that describes the field requirement.

Last modified: 7 March 2019