Package pro.taskana.classification.api.models

Interface Classification

All Superinterfaces:
ClassificationSummary
All Known Implementing Classes:
ClassificationImpl
public interface Classification extends ClassificationSummary
Interface used to specify the Classification-Model.

  • Method Details

    • setParentId

      void setParentId(String parentId)
      Sets/Changes a reference to the current parent Classification via id. If the Classification has no parent, the value of parentId should be an empty String.
      Parameters:
      parentId - the id of the parent Classification

    • setParentKey

      void setParentKey(String parentKey)
      Sets/Changes a reference to the current parent Classification via key. If the Classification has no parent, the value of parentKey should be an empty String.
      Parameters:
      parentKey - the key of the parent Classification

    • setCategory

      void setCategory(String category)
      Sets/Changes the category of the Classification.
      Parameters:
      category - the category of the Classification

    • getDomain

      String getDomain()
      Returns the current domain of the Classification.
      Specified by:
      getDomain in interface ClassificationSummary
      Returns:
      domain

    • getApplicationEntryPoint

      String getApplicationEntryPoint()
      Returns the logical name of the associated applicationEntryPoint of the Classification.
      Specified by:
      getApplicationEntryPoint in interface ClassificationSummary
      Returns:
      applicationEntryPoint

    • setApplicationEntryPoint

      void setApplicationEntryPoint(String applicationEntryPoint)
      Sets the logical name of the associated applicationEntryPoint of the Classification.
      Parameters:
      applicationEntryPoint - the applicationEntryPoint

    • copy

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

    • getIsValidInDomain

      Boolean getIsValidInDomain()
      Returns whether the Classification is currently valid in the used domain.
      Returns:
      isValidInDomain

    • setIsValidInDomain

      void setIsValidInDomain(Boolean isValidInDomain)
      Sets/Changes the flag which marks the Classification as valid/invalid in the currently used domain.
      Parameters:
      isValidInDomain - flag

    • getCreated

      Instant getCreated()
      Returns the time when the Classification was created.
      Returns:
      the time of creation as Instant

    • getModified

      Instant getModified()
      Returns the time when the Classification was modified the last time.
      Returns:
      the time of last modification as Instant

    • setName

      void setName(String name)
      Sets/Changes the name of the Classification.
      Parameters:
      name - the name of the Classification

    • getDescription

      String getDescription()
      Returns the description of the Classification.
      Returns:
      description

    • setDescription

      void setDescription(String description)
      Sets/Changes the description of the Classification.
      Parameters:
      description - the description of the Classification

    • setPriority

      void setPriority(int priority)
      Sets/Changes the numeric priority of the Classification.
      Parameters:
      priority - the priority of the Classification

    • setServiceLevel

      void setServiceLevel(String serviceLevel)
      Sets/Changes the serviceLevel of the Classification.
      Parameters:
      serviceLevel - the serviceLevel; must be a String in ISO-8601 duration format; see the parse() method of Duration for details

    • setCustomAttribute

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

    • setCustomField

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

    • asSummary

      ClassificationSummary asSummary()
      Return a summary of the Classification.
      Returns:
      the ClassificationSummary object for the current Classification