com.atlassian.jira.sharing
Class SharedEntity.Identifier

java.lang.Object
  extended by com.atlassian.jira.sharing.SharedEntity.Identifier
All Implemented Interfaces:
Favourite, SharedEntity
Enclosing interface:
SharedEntity

public static class SharedEntity.Identifier
extends java.lang.Object
implements SharedEntity

Utility class for identifying a SharedEntity. This can be used instead of a "proper" implementation.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.atlassian.jira.sharing.SharedEntity
SharedEntity.Identifier, SharedEntity.SharePermissions, SharedEntity.TypeDescriptor<S extends SharedEntity>
 
Constructor Summary
SharedEntity.Identifier(java.lang.Long id, SharedEntity.TypeDescriptor<? extends SharedEntity> type, java.lang.String ownerUserName)
           
SharedEntity.Identifier(java.lang.Long id, SharedEntity.TypeDescriptor<? extends SharedEntity> type, com.opensymphony.user.User owner)
           
 
Method Summary
 boolean equals(java.lang.Object o)
           
 java.lang.String getDescription()
          A general description of the entity.
 SharedEntity.TypeDescriptor<SharedEntity> getEntityType()
          The type of entity it is.
 java.lang.Long getFavouriteCount()
          The number of users who have marked this entity as one of their favourites.
 java.lang.Long getId()
          The id of the entity.
 java.lang.String getName()
          The name of the entity.
 java.lang.String getOwnerUserName()
          The user name of the owner of the entity.
 SharedEntity.SharePermissions getPermissions()
          The permissions for this entity.
 int hashCode()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SharedEntity.Identifier

public SharedEntity.Identifier(java.lang.Long id,
                               SharedEntity.TypeDescriptor<? extends SharedEntity> type,
                               java.lang.String ownerUserName)

SharedEntity.Identifier

public SharedEntity.Identifier(java.lang.Long id,
                               SharedEntity.TypeDescriptor<? extends SharedEntity> type,
                               com.opensymphony.user.User owner)
Method Detail

getId

public java.lang.Long getId()
Description copied from interface: SharedEntity
The id of the entity.

Specified by:
getId in interface SharedEntity
Returns:
the id. May be null if not yet persisted. Some components may not accept a non-persisted entity.

getOwnerUserName

public java.lang.String getOwnerUserName()
Description copied from interface: SharedEntity
The user name of the owner of the entity. Will always have permission to see it and see all shares.

Specified by:
getOwnerUserName in interface SharedEntity
Returns:
The user name of the user who owns this entity. May be null for anonymous user.

getEntityType

public SharedEntity.TypeDescriptor<SharedEntity> getEntityType()
Description copied from interface: SharedEntity
The type of entity it is. Examples include SearchRequest ("SearchRequest") and PortalPage ("PortalPage")

Specified by:
getEntityType in interface SharedEntity
Returns:
the type of entity.

getName

public java.lang.String getName()
Description copied from interface: SharedEntity
The name of the entity.

Specified by:
getName in interface SharedEntity
Returns:
the name. Must not be null or empty.

getDescription

public java.lang.String getDescription()
Description copied from interface: SharedEntity
A general description of the entity.

Specified by:
getDescription in interface SharedEntity
Returns:
the description. May be null or empty.

getPermissions

public SharedEntity.SharePermissions getPermissions()
Description copied from interface: SharedEntity
The permissions for this entity.

Specified by:
getPermissions in interface SharedEntity
Returns:
the permissions object. Must not be null.

getFavouriteCount

public java.lang.Long getFavouriteCount()
Description copied from interface: Favourite
The number of users who have marked this entity as one of their favourites.

Specified by:
getFavouriteCount in interface Favourite
Returns:
long the user count

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2002-2010 Atlassian. All Rights Reserved.