Package com.polarion.alm.shared.api.model.plan

Interface PlanFields

All Superinterfaces:

Fields, Iterable<Field>, IterableWithSize<Field>

All Known Subinterfaces:

UpdatablePlanFields

public interface PlanFields
extends Fields

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
PlanWorkField	_doneWork()	Shows value of PlanStatistics.doneAsString().
PlanProgressField	_progress()	Leading underscores and parentheses must be omitted for Velocity scripts, i.e., $plan.fields.progress.
PlanWorkField	_remainingWork()	Shows value of PlanStatistics.todoAsString().
PlanWorkField	_totalWork()	Shows value of PlanStatistics.plannedAsString().
EnumOptionsField	allowedTypes()
UserField	author()
EnumOptionField	calculationType()
FloatField	capacity()
StringField	color()
DateField	created()
FloatField	defaultEstimate()
PlainTextField	description()
DateOnlyField	dueDate()
FieldReferenceField	estimationField()
DateField	finishedOn()
RichTextField	homePageContent()
IdField	id()
BooleanField	isTemplate()
LocationField	location()
StringField	name()
PlanField	parent()
DurationField	previousTimeSpent()
FieldReferenceField	prioritizationField()
ProjectField	project()
ProjectsField	projectSpan()
PlanRecordsField	records()
IntegerField	sortOrder()
DateOnlyField	startDate()
DateField	startedOn()
EnumOptionField	status()
PlanField	template()
DateField	updated()
BooleanField	useReportFromTemplate()

Methods inherited from interface com.polarion.alm.shared.api.model.fields.Fields

get, getByPath

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.polarion.alm.shared.api.utils.collections.IterableWithSize

addAllTo, isEmpty, size, toArray, toArrayList

Method Details

id

@NotNull
IdField id()

project

@NotNull
ProjectField project()

name

@NotNull
StringField name()

description

@NotNull
PlainTextField description()

homePageContent

@NotNull
RichTextField homePageContent()

Since:

3.9.1

records

@NotNull
PlanRecordsField records()

parent

@NotNull
PlanField parent()

startDate

@NotNull
DateOnlyField startDate()

dueDate

@NotNull
DateOnlyField dueDate()

status

@NotNull
EnumOptionField status()

startedOn

@NotNull
DateField startedOn()

finishedOn

@NotNull
DateField finishedOn()

allowedTypes

@NotNull
EnumOptionsField allowedTypes()

prioritizationField

@NotNull
FieldReferenceField prioritizationField()

projectSpan

@NotNull
ProjectsField projectSpan()

calculationType

@NotNull
EnumOptionField calculationType()

estimationField

@NotNull
FieldReferenceField estimationField()

defaultEstimate

@NotNull
FloatField defaultEstimate()

capacity

@NotNull
FloatField capacity()

previousTimeSpent

@NotNull
DurationField previousTimeSpent()

isTemplate

@NotNull
BooleanField isTemplate()

template

@NotNull
PlanField template()

useReportFromTemplate

@NotNull
BooleanField useReportFromTemplate()

Since:

3.9.2

sortOrder

@NotNull
IntegerField sortOrder()

color

@NotNull
StringField color()

author

@NotNull
UserField author()

created

@NotNull
DateField created()

updated

@NotNull
DateField updated()

location

@NotNull
LocationField location()

_totalWork

@NotNull
PlanWorkField _totalWork()

Shows value of PlanStatistics.plannedAsString(). Leading underscores and parentheses must be omitted for Velocity scripts, i.e., $plan.fields.totalWork.

_doneWork

@NotNull
PlanWorkField _doneWork()

Shows value of PlanStatistics.doneAsString(). Leading underscores and parentheses must be omitted for Velocity scripts, i.e., $plan.fields.doneWork.

_remainingWork

@NotNull
PlanWorkField _remainingWork()

Shows value of PlanStatistics.todoAsString(). Leading underscores and parentheses must be omitted for Velocity scripts, i.e., $plan.fields.remainingWork.

_progress

@NotNull
PlanProgressField _progress()

Leading underscores and parentheses must be omitted for Velocity scripts, i.e., $plan.fields.progress.