Package pro.taskana.workbasket.api.models

Interface Workbasket

All Superinterfaces:
WorkbasketSummary
All Known Implementing Classes:
WorkbasketImpl
public interface Workbasket extends WorkbasketSummary
Workbasket entity interface.

  • Method Details

    • setName

      void setName(String workbasketName)
      Sets the name of the Workbasket.
      Parameters:
      workbasketName - the name of the Workbasket

    • setDescription

      void setDescription(String description)
      Sets the description of the Workbasket.
      Parameters:
      description - the description of the Workbasket

    • setType

      void setType(WorkbasketType type)
      Sets the type of the Workbasket.
      Parameters:
      type - the type of the Workbasket

    • setCustomAttribute

      @Deprecated void setCustomAttribute(WorkbasketCustomField customField, String value)
      Deprecated.
      Use setCustomField(WorkbasketCustomField, String) instead
      Sets the value of the specified WorkbasketCustomField.
      Parameters:
      customField - identifies which WorkbasketCustomField is to be set
      value - the value of the WorkbasketCustomField to be set

    • setCustomField

      void setCustomField(WorkbasketCustomField customField, String value)
      Sets the value for the specified WorkbasketCustomField.
      Parameters:
      customField - identifies which WorkbasketCustomField is to be set.
      value - the value of the WorkbasketCustomField to be set

    • setOrgLevel1

      void setOrgLevel1(String orgLevel1)
      Sets the value for orgLevel1 attribute.
      Parameters:
      orgLevel1 - the orgLevel1 property of the Workbasket

    • setOrgLevel2

      void setOrgLevel2(String orgLevel2)
      Sets the value for orgLevel2 attribute.
      Parameters:
      orgLevel2 - the orgLevel2 property of the Workbasket

    • setOrgLevel3

      void setOrgLevel3(String orgLevel3)
      Sets the value for orgLevel3 attribute.
      Parameters:
      orgLevel3 - the orgLevel3 property of the Workbasket

    • setOrgLevel4

      void setOrgLevel4(String orgLevel4)
      Sets the value for orgLevel4 attribute.
      Parameters:
      orgLevel4 - the orgLevel4 of the Workbasket

    • isMarkedForDeletion

      boolean isMarkedForDeletion()
      Checks if the Workbasket is marked for deletion.
      Specified by:
      isMarkedForDeletion in interface WorkbasketSummary
      Returns:
      the markedForDeletion flag

    • setMarkedForDeletion

      void setMarkedForDeletion(boolean markedForDeletion)
      Sets the value for markedForDeletion flag.
      Parameters:
      markedForDeletion - the markedForDeletion flag of the Workbasket

    • copy

      Workbasket copy(String key)
      Duplicates the Workbasket without the id.
      Parameters:
      key - for the new Workbasket
      Returns:
      a copy of this Workbasket

    • setOwner

      void setOwner(String owner)
      Sets the owner of the Workbasket.
      Parameters:
      owner - the id of the owner of the current Workbasket

    • getCreated

      Instant getCreated()
      Returns the time when the Workbasket was created.
      Returns:
      the created Instant

    • getModified

      Instant getModified()
      Returns the time when the Workbasket was modified last time.
      Returns:
      the modified Instant

    • asSummary

      WorkbasketSummary asSummary()
      Returns a summary of the current Workbasket.
      Returns:
      the WorkbasketSummary object for the current Workbasket