Package pw.chew.clickup4j.api.entities.customfields

Interface ManualProgressCustomField

All Superinterfaces:

ICustomField

All Known Implementing Classes:

ManualProgressCustomFieldImpl

public interface ManualProgressCustomField
extends ICustomField

Method Summary

Modifier and Type	Method	Description
int	getEndValue()	This is the maximum possible for the progress bar.
Float	getPercentCompleted()	Returns the overall percent completed for this custom field.
int	getStartValue()	This is the minimum possible for the progress bar.
default CustomFieldType	getType()	Returns the type of this custom field.
String	getValue()	Gets the currently shown progress bar value.

Methods inherited from interface pw.chew.clickup4j.api.entities.customfields.ICustomField

getClickUp4j, getId, getName, getTimeCreated, isRequired

Method Details

getValue

String getValue()

Gets the currently shown progress bar value. If you want the percent completed, use getPercentCompleted().

Specified by:

getValue in interface ICustomField

Returns:

The current progress bar value.

getPercentCompleted

Float getPercentCompleted()

Returns the overall percent completed for this custom field. This is essentially (getValue() - getStartValue()) / (getEndValue() - getStartValue()).

Returns:

The percent completed.

getStartValue

int getStartValue()

This is the minimum possible for the progress bar.

Returns:

The minimum value.

getEndValue

int getEndValue()

This is the maximum possible for the progress bar.

Returns:

The maximum value.

getType

default CustomFieldType getType()

Description copied from interface: ICustomField

Returns the type of this custom field. This will be one of CustomFieldType.

Specified by:

getType in interface ICustomField

Returns:

the type of this custom field