Package com.solibri.smc.api.communication

Interface Comment

public interface Comment
A Comment represents a single comment in a BCF context.
Since:
9.10.8

  • Method Details

    • create

      static Comment create()
      Creates an empty Comment.
      Returns:
      the new empty Comment
      Since:
      9.12.0

    • create

      static Comment create​(UUID uuid)
      Creates an empty Comment with the specified UUID.
      Parameters:
      uuid - the UUID of the Comment
      Returns:
      the new empty Comment
      Since:
      9.12.0

    • getUniqueId

      String getUniqueId()
      Returns the unique ID of the comment.
      Returns:
      the ID of the comment
      Since:
      9.12.0

    • getCreationDate

      LocalDateTime getCreationDate()
      Returns the creation date of this comment.
      Returns:
      the creation date
      Since:
      9.12.0

    • setCreationDate

      void setCreationDate​(LocalDateTime creationDate)
      Set the creation date of this comment.
      Parameters:
      creationDate - the date
      Since:
      9.12.0

    • getText

      String getText()
      Returns the text of this comment.
      Returns:
      the text
      Since:
      9.10.8

    • getAuthor

      String getAuthor()
      Returns the author of the comment.
      Returns:
      the author
      Since:
      9.12.0

    • setAuthor

      void setAuthor​(String author)
      Sets the author of this comment.
      Parameters:
      author - the author
      Since:
      9.12.0

    • addExternalID

      boolean addExternalID​(UUID uuid)
      Add an id this comment has in some external system.
      Parameters:
      uuid - the external id
      Returns:
      true when the id didn't exist previously
      Since:
      9.12.0

    • removeExternalID

      boolean removeExternalID​(UUID uuid)
      Remove an id this comment has in some external system.
      Parameters:
      uuid - the external id
      Returns:
      true when the id existed and was removed
      Since:
      9.12.0

    • getExternalIds

      Set<UUID> getExternalIds()
      Returns all the external IDs for this comment.
      Returns:
      all the external IDs
      Since:
      9.12.0

    • setText

      void setText​(String text)
      Updates this comment with given text if the author of the comment is current user.
      Parameters:
      text - the text
      Since:
      9.12.0