IssueLinkPrototype

Represents an issue link type.

Properties

Name	Type	Description
becomesRemoved	`Boolean`	Read-only. When `true`, the entity is removed in the current transaction. Otherwise, `false`. Available since 2017.4.37915
inward	`String`	Read-only. The inward name of the issue link type.
isNew	`Boolean`	Read-only. When `true`, the entity is created in the current transaction. Otherwise, `false`. Available since 2018.2.42351
outward	`String`	Read-only. The outward name of the issue link type.

Methods

findByName

static findByName(name)

Finds an issue link type by its inward or outward name.

Parameters

Name	Type	Description
name	`String`	The inward or outward name of an issue link type.

Return Value

Type	Description
`IssueLinkPrototype`	The issue link type.

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

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

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

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: 17 December 2019