com.atlassian.jira.sharing
Interface SharedEntity

All Superinterfaces:
Favourite
All Known Subinterfaces:
PortalPage
All Known Implementing Classes:
AbstractPortalPageImpl, DefaultPortalPageImpl, PortalPageImpl, SearchRequest, SharedEntity.Indentifier

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

Nested Class Summary
static class SharedEntity.Indentifier
          Utility class for identifying a SharedEntity.
static class SharedEntity.SharePermissions
          Encapsulates the permissions that a SharedEntity has.
static class SharedEntity.TypeDescriptor
          The name and type of a SharedEntity.
 
Method Summary
 String getDescription()
          A general description of the entity.
 SharedEntity.TypeDescriptor getEntityType()
          The type of entity it is.
 Long getId()
          The id of the entity.
 String getName()
          The name of the entity.
 String getOwnerUserName()
          The user name of the owner of the entity.
 SharedEntity.SharePermissions getPermissions()
          The permissions for this entity.
 
Methods inherited from interface com.atlassian.jira.favourites.Favourite
getFavouriteCount
 

Method Detail

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

SharedEntity.TypeDescriptor getEntityType()
The type of entity it is. Examples include SearchRequest ("SearchRequest") and PortalPage ("PortalPage")

Returns:
the type of entity.

getOwnerUserName

String getOwnerUserName()
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.

getPermissions

SharedEntity.SharePermissions getPermissions()
The permissions for this entity.

Returns:
the permissions object. Must not be null.


Copyright © 2002-2008 Atlassian. All Rights Reserved.