java.lang.Object | |||
↳ | com.atlassian.jira.issue.fields.AbstractField | ||
↳ | com.atlassian.jira.issue.fields.AbstractOrderableField<V> | ||
↳ | com.atlassian.jira.issue.fields.WorklogSystemField |
A field representation of logging work.
This allows JIRA administrators to place the "Log Work" field on screens. This means that JIRA users can now log
work whilst creating, editing or transitioning issues. The field works in a similar way to the
CommentSystemField
in that while it implements the "getEditHtml" method, previously entered work logs cannot
be edited. In effect, the only functionality available is to "add" more work logs.
The WorklogService
is used to do the hard work of validating and creating the work logs from user input.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
WorklogSystemField.WorklogValue | A value object used to aggregate all the transient values required in taking input from the UI, validating it and creating the resultant work logs. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns lower level Information about the field.
| |||||||||||
Return The default data for this system field.
| |||||||||||
Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation
of the rendered data for easy display.
| |||||||||||
Return a description of the shape of this field when represented as JSON.
| |||||||||||
Gets the value stored for this field on the provided issue.
| |||||||||||
Defines if a field determines itself as renderable.
| |||||||||||
Sets the value as a modified external field in the issue so that this
field will be updated along with all the other modified issue values.
| |||||||||||
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Defines the object that will be passed through to the create method
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url
fieldTypeInfoContext | the FieldTypeInfoContext contains context information that is relevant to generate the FieldTypeInfo
|
---|
Return The default data for this system field. May be null if there is no default.
issueCtx | Issue (This should really only need to be an issue context, but for historical reasons we need an issue object. |
---|
Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.
issue | to get field data from |
---|---|
renderedVersionRequested | whether the use requested the return of rendered/pretty data as well as raw data |
fieldLayoutItem | field layout for this field. Will only be supplied if the field is also an ordereable field. |
Return a description of the shape of this field when represented as JSON.
Gets the value stored for this field on the provided issue.
issue | identifies the issue that will contain the value for this field. |
---|
FieldValidationException |
---|
Defines if a field determines itself as renderable. This is needed because of the way that customfields are implemented. Since all the real work is done in CustomFieldTypes, if we want to treat system fields and custom fields the same way in the renderers then all custom fields must implement this interface. We therefore provide this method so that the CustomFieldImpl can delegate to the CustomFieldTypes to determine if a given custom field is renderable.
FieldValidationException |
---|
Sets the value as a modified external field in the issue so that this field will be updated along with all the other modified issue values.
Defines the object that will be passed through to the create method
inputParameters | is a representation of the request params that are available |
---|
WorklogSystemField.WorklogValue