Package pw.chew.clickup4j.api.entities

Interface Target

All Known Implementing Classes:
TargetImpl
public interface Target

Goal Targets

In ClickUp, goals can have targets (internally known as key results). This helps track the overall progress of a goal.

  • Method Details

    • getId

      @NotNull @NotNull UUID getId()
      The unique identifier of the target.
      Returns:
      never-null UUID of the target

    • getGoal

      @NotNull @NotNull Goal getGoal()
      The Goal this target belongs to.
      Returns:
      never-null Goal this target belongs to

    • getName

      @NotNull @NotNull String getName()
      Returns the name of the target.
      Returns:
      never-null name of the target

    • getCreatorId

      @NotNull @NotNull String getCreatorId()
      Returns the ID of the User who created the target.
      Returns:
      never-null ID of the User who created the target

    • getOwner

      @Nullable @Nullable User getOwner()
      Returns the owner of the target.
      Returns:
      nullable User owner of the target

    • getType

      @NotNull @NotNull String getType()
      Returns the type of the target.
      Returns:
      never-null type of the target

    • getDateCreated

      @NotNull @NotNull OffsetDateTime getDateCreated()
      Returns the date and time when the target was created.
      Returns:
      never-null date and time when the target was created

    • getStepsStart

      int getStepsStart()
      The number of steps to start with.
      Returns:
      number of steps to start with

    • getStepsEnd

      int getStepsEnd()
      The number of steps to complete.
      Returns:
      number of steps to complete

    • getCurrentStep

      int getCurrentStep()
      Returns the current number of steps.
      Returns:
      current number of steps

    • getUnit

      @NotNull @NotNull String getUnit()
      Returns the unit of measurement for a step.
      Returns:
      never-null unit of measurement for a step

    • getPercentCompleted

      float getPercentCompleted()
      Returns the current percentage of completion.
      Returns:
      current percentage of completion

    • isCompleted

      boolean isCompleted()
      Returns if this target is completed.
      Returns:
      true if this target is completed, false otherwise

    • getLastAction

      @NotNull @NotNull TimelineEntry getLastAction()
      Returns the most recent action that was performed on the target.
      Returns:
      never-null TimelineEntry most recent action performed on the target

    • getClickUp4j

      @NotNull @NotNull ClickUp4j getClickUp4j()
      Returns this ClickUp4j instance.
      Returns:
      never-null ClickUp4j instance.