Agile
Represents an agile board and the set of sprints that belong to the board.
Extends BaseEntity.
Properties
Name | Type | Description |
|---|---|---|
author | User | Read-only. The user who created the board. |
becomesRemoved | Boolean | Read-only. When `true`, the entity is removed in the current transaction. Otherwise, `false`. Available since 2017.4.37915 |
isNew | Boolean | Read-only. When `true`, the entity is created in the current transaction. Otherwise, `false`. Available since 2018.2.42351 |
name | String | Read-only. The name of the agile board. |
sprints | Set.<Sprint> | Read-only. The set of sprints that are associated with the board. |
Methods
findByName
Returns a set of agile boards that have the specified name.
Parameters
Name | Type | Description |
|---|---|---|
name | String | The name of an agile board. |
Return Value
Type | Description |
|---|---|
Set.<Agile> | A set of agile boards that are assigned the specified name. |
becomes
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
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
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`. |
findSprintByName
Finds a specific sprint by name.
Parameters
Name | Type | Description |
|---|---|---|
name | String | The name of the sprint. |
Return Value
Type | Description |
|---|---|
Sprint | If a sprint with the specified name is found, the corresponding Sprint object is returned. Otherwise, the return value is null. |
getIssueSprints
Returns the sprints that an issue is assigned to on an agile board.
Available since 2018.1.39547
Parameters
Name | Type | Description |
|---|---|---|
issue | Issue | The issue for which you want to get the sprints that it is assigned to. |
Return Value
Type | Description |
|---|---|
Set.<Sprint> | The sprints that the issue is assigned to on the agile board. |
isChanged
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
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
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. |