Package com.atlassian.jira.sharing

Interface SharedEntity

All Superinterfaces:
Favourite
All Known Implementing Classes:
IndexableSharedEntity, MockJqlSearchRequest, PortalPage, SearchRequest, SharedEntity.Identifier
@PublicApi public interface SharedEntity extends Favourite
Classes that implement this interface are able to Shared and Favourited. The Favouriting and Sharing mechanism need the type of object it is and the id.
Since:
v3.13

  • Method Details

    • getId

      Long getId()
      The id of the entity.
      Returns:
      the id. May be null if not yet persisted. Some components may not accept a non-persisted entity.

    • getName

      String getName()
      The name of the entity.
      Returns:
      the name. Must not be null or empty.

    • getDescription

      String getDescription()
      A general description of the entity.
      Returns:
      the description. May be null or empty.

    • getEntityType

      <S extends SharedEntity> SharedEntity.TypeDescriptor<S> getEntityType()
      The type of entity it is. Examples include SearchRequest ("SearchRequest") and PortalPage ("PortalPage")
      Returns:
      the type of entity.

    • getOwnerUserName

      String getOwnerUserName()
      Deprecated.
      Use getOwner() instead. Since v6.0.

      The user name of the owner of the entity. Will always have permission to see it and see all shares.

      Returns:
      The user name of the user who owns this entity. May be null for anonymous user.

    • getOwner

      ApplicationUser getOwner()

    • getPermissions

      SharedEntity.SharePermissions getPermissions()
      The permissions for this entity.
      Returns:
      the permissions object. Must not be null.