Package com.atlassian.confluence.core

Class AbstractLabelableEntityObject

java.lang.Object
com.atlassian.core.bean.EntityObject
com.atlassian.confluence.core.AnnotatedEntityObject
com.atlassian.confluence.core.ConfluenceEntityObject
com.atlassian.confluence.core.AbstractVersionedEntityObject
com.atlassian.confluence.core.AbstractLabelableEntityObject
All Implemented Interfaces:
Versioned, EditableLabelable, Labelable, Serializable, Cloneable
Direct Known Subclasses:
ContentEntityObject, PageTemplate
public abstract class AbstractLabelableEntityObject extends AbstractVersionedEntityObject implements EditableLabelable
See Also:

  • Constructor Details

    • AbstractLabelableEntityObject

      public AbstractLabelableEntityObject()

  • Method Details

    • getLabels

      public List<Label> getLabels()
      Description copied from interface: Labelable
      Retrieve the labels that are associated with this object.
      Specified by:
      getLabels in interface Labelable
      Returns:
      a list of label instances.

    • getLabelCount

      public int getLabelCount()
      Description copied from interface: Labelable
      Get the number of labels that are associated with this object.
      Specified by:
      getLabelCount in interface Labelable
      Returns:
      the number of labels associated with this object.

    • isFavourite

      public boolean isFavourite(ConfluenceUser user)
      Description copied from interface: Labelable
      Is this object marked as somebody's favourite?
      Specified by:
      isFavourite in interface Labelable
      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

    • getVisibleLabels

      public List<Label> getVisibleLabels(com.atlassian.user.User user)
      List the labels on this content that are visible to a particular user
      Parameters:
      user - the user
      Returns:
      the labels on this content visible to that user

    • getPersonalLabels

      @Deprecated(forRemoval=true, since="9.3") public List<Label> getPersonalLabels(com.atlassian.user.User user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use LabelPermissionEnforcer.filterLabelsByNamespace(List, User, Namespace)
      List the labels on this content that are personal labels for a particular user
      Parameters:
      user - the user
      Returns:
      the personal labels on this content visible to the user

    • getGlobalLabels

      @Deprecated(forRemoval=true, since="9.3") public List<Label> getGlobalLabels(com.atlassian.user.User user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use LabelPermissionEnforcer.filterLabelsByNamespace(List, User, Namespace)
      List the labels on this content that are global labels
      Parameters:
      user - the user
      Returns:
      the global labels on this content visible to the user

    • getTeamLabels

      @Deprecated(forRemoval=true, since="9.3") public List<Label> getTeamLabels(com.atlassian.user.User user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use LabelPermissionEnforcer.filterLabelsByNamespace(List, User, Namespace)
      List the labels on this content that are team labels for a particular user
      Parameters:
      user - the user
      Returns:
      the team labels on this content visible to the user

    • getLabelsForDisplay

      public List<Label> getLabelsForDisplay(com.atlassian.user.User user)
      List the labels on this content that are visible to a particular user, and should be shown in a list of labels. This is like {code}getVisibleLabels{code} except that it also filters out special labels like favourites
      Parameters:
      user - the user
      Returns:
      the labels on this content visible to that user

    • setLabellings

      protected void setLabellings(List<Labelling> labellings)

    • getLabellings

      public List<Labelling> getLabellings()
      Specified by:
      getLabellings in interface EditableLabelable

    • addLabelling

      public void addLabelling(Labelling content)
      Specified by:
      addLabelling in interface EditableLabelable

    • removeLabelling

      public void removeLabelling(Labelling labelling)
      Specified by:
      removeLabelling in interface EditableLabelable

    • clone

      public Object clone() throws CloneNotSupportedException
      Overrides:
      clone in class com.atlassian.core.bean.EntityObject
      Throws:
      CloneNotSupportedException