com.atlassian.jira.sharing

Class SharedEntity.Identifier

java.lang.Object

com.atlassian.jira.sharing.SharedEntity.Identifier

All Implemented Interfaces:

Favourite, SharedEntity

Enclosing interface:

SharedEntity

public static class SharedEntity.Identifier
extends 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

Constructors

Constructor and Description
Identifier(Long id, SharedEntity.TypeDescriptor<? extends SharedEntity> type, ApplicationUser owner)
Identifier(Long id, SharedEntity.TypeDescriptor<? extends SharedEntity> type, String ownerUserName) Deprecated. Use #Identifier(Long, com.atlassian.jira.sharing.SharedEntity.TypeDescriptor, com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription() A general description of the entity.
SharedEntity.TypeDescriptor<SharedEntity>	getEntityType() The type of entity it is.
Long	getFavouriteCount() The number of users who have marked this entity as one of their favourites.
Long	getId() The id of the entity.
String	getName() The name of the entity.
ApplicationUser	getOwner()
String	getOwnerUserName()
SharedEntity.SharePermissions	getPermissions() The permissions for this entity.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Identifier

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

Deprecated. Use #Identifier(Long, com.atlassian.jira.sharing.SharedEntity.TypeDescriptor, com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.

Parameters:

id -

type -

ownerUserName -

Identifier

public Identifier(Long id,
                  SharedEntity.TypeDescriptor<? extends SharedEntity> type,
                  ApplicationUser owner)

Method Detail

getId

public 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.

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 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 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.

getOwnerUserName

public String getOwnerUserName()

Specified by:

getOwnerUserName in interface SharedEntity

Returns:

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

getOwner

public ApplicationUser getOwner()

Specified by:

getOwner in interface SharedEntity

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 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(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object