Package com.atlassian.confluence.labels

Interface Labelable

All Known Subinterfaces:
EditableLabelable
All Known Implementing Classes:
AbstractLabelableEntityObject, AbstractPage, Attachment, BlogPost, Comment, ContentEntityObject, CustomContentEntityObject, Draft, GlobalDescription, Page, PageTemplate, PermittedLabelView, PersonalInformation, ReadOnlyAttachment, ReadOnlySpaceDescription, SpaceContentEntityObject, SpaceDescription
public interface Labelable
Interface for objects that can have labels applied to them.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getLabelCount()
    Get the number of labels that are associated with this object.
    List<Label>
    getLabels()
    Retrieve the labels that are associated with this object.
    boolean
    isFavourite(ConfluenceUser user)
    Is this object marked as somebody's favourite?

  • Method Details

    • getLabels

      List<Label> getLabels()
      Retrieve the labels that are associated with this object.
      Returns:
      a list of label instances.

    • getLabelCount

      int getLabelCount()
      Get the number of labels that are associated with this object.
      Returns:
      the number of labels associated with this object.

    • isFavourite

      boolean isFavourite(ConfluenceUser user)
      Is this object marked as somebody's favourite?
      Parameters:
      user - the user who is being checked against. If user is null this method must always return false (anonymous users can not mark anything as a favourite, obviously)
      Returns:
      true if the labelable object is a 'favourite' of a given user, false otherwise
      Since:
      5.2