Uses of Interface
com.atlassian.jira.sharing.SharedEntity

Packages that use SharedEntity

Package	Description
com.atlassian.jira.bc.favourites
com.atlassian.jira.favourites
com.atlassian.jira.index.ha
com.atlassian.jira.issue.search
com.atlassian.jira.portal
com.atlassian.jira.portal.events
com.atlassian.jira.sharing
com.atlassian.jira.sharing.index
com.atlassian.jira.sharing.search
com.atlassian.jira.sharing.type
com.atlassian.jira.web.action.util.sharing

Uses of SharedEntity in com.atlassian.jira.bc.favourites

Methods in com.atlassian.jira.bc.favourites with parameters of type SharedEntity

Modifier and Type	Method and Description
void	DefaultFavouritesService.addFavourite(JiraServiceContext ctx, SharedEntity entity)
void	FavouritesService.addFavourite(JiraServiceContext ctx, SharedEntity entity) Add the given entity as a favourite of the user passed in the context
void	DefaultFavouritesService.addFavouriteInPosition(JiraServiceContext ctx, SharedEntity entity, long position)
void	FavouritesService.addFavouriteInPosition(JiraServiceContext ctx, SharedEntity entity, long position) Add the given entity as a favourite of the user passed in the context and place it in the specified position.
boolean	DefaultFavouritesService.isFavourite(ApplicationUser user, SharedEntity entity)
boolean	FavouritesService.isFavourite(ApplicationUser user, SharedEntity entity) Check that the given entity is a favourite of the user passed in the context
boolean	DefaultFavouritesService.isFavourite(com.atlassian.crowd.embedded.api.User user, SharedEntity entity)
boolean	FavouritesService.isFavourite(com.atlassian.crowd.embedded.api.User user, SharedEntity entity) Deprecated. Use FavouritesService.isFavourite(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.sharing.SharedEntity) instead. Since v6.0. Check that the given entity is a favourite of the user passed in the context
void	DefaultFavouritesService.removeFavourite(JiraServiceContext ctx, SharedEntity entity)
void	FavouritesService.removeFavourite(JiraServiceContext ctx, SharedEntity entity) Remove the given entity as a favourite of the user passed in the context

Constructor parameters in com.atlassian.jira.bc.favourites with type arguments of type SharedEntity

Constructor and Description
DefaultFavouritesService(FavouritesManager<SharedEntity> favouritesManager)

Uses of SharedEntity in com.atlassian.jira.favourites

Classes in com.atlassian.jira.favourites with type parameters of type SharedEntity

Modifier and Type	Interface and Description
interface	FavouritesManager<S extends SharedEntity> Manager for basic Favourites functionality.

Methods in com.atlassian.jira.favourites with parameters of type SharedEntity

Modifier and Type	Method and Description
boolean	OfBizFavouritesStore.addFavourite(ApplicationUser user, SharedEntity entity)
boolean	CachingFavouritesStore.addFavourite(ApplicationUser user, SharedEntity entity)
void	DefaultFavouritesManager.addFavourite(ApplicationUser user, SharedEntity entity)
boolean	FavouritesStore.addFavourite(ApplicationUser user, SharedEntity entity) Create Favourites association between User and entity
void	DefaultFavouritesManager.addFavourite(com.atlassian.crowd.embedded.api.User user, SharedEntity entity)
void	DefaultFavouritesManager.addFavouriteInPosition(ApplicationUser user, SharedEntity entity, long position)
void	DefaultFavouritesManager.addFavouriteInPosition(com.atlassian.crowd.embedded.api.User user, SharedEntity entity, long position)
void	DefaultFavouritesManager.decreaseFavouriteSequence(ApplicationUser user, SharedEntity entity)
void	DefaultFavouritesManager.decreaseFavouriteSequence(com.atlassian.crowd.embedded.api.User user, SharedEntity entity)
void	DefaultFavouritesManager.increaseFavouriteSequence(ApplicationUser user, SharedEntity entity)
void	DefaultFavouritesManager.increaseFavouriteSequence(com.atlassian.crowd.embedded.api.User user, SharedEntity entity)
boolean	OfBizFavouritesStore.isFavourite(ApplicationUser user, SharedEntity entity)
boolean	CachingFavouritesStore.isFavourite(ApplicationUser user, SharedEntity entity)
boolean	DefaultFavouritesManager.isFavourite(ApplicationUser user, SharedEntity entity)
boolean	FavouritesStore.isFavourite(ApplicationUser user, SharedEntity entity) Checks to see if entity is a favourite of the user passed in.
boolean	DefaultFavouritesManager.isFavourite(com.atlassian.crowd.embedded.api.User user, SharedEntity entity)
void	DefaultFavouritesManager.moveToEndFavouriteSequence(ApplicationUser user, SharedEntity entity)
void	DefaultFavouritesManager.moveToEndFavouriteSequence(com.atlassian.crowd.embedded.api.User user, SharedEntity entity)
void	DefaultFavouritesManager.moveToStartFavouriteSequence(ApplicationUser user, SharedEntity entity)
void	DefaultFavouritesManager.moveToStartFavouriteSequence(com.atlassian.crowd.embedded.api.User user, SharedEntity entity)
boolean	OfBizFavouritesStore.removeFavourite(ApplicationUser user, SharedEntity entity)
boolean	CachingFavouritesStore.removeFavourite(ApplicationUser user, SharedEntity entity)
void	DefaultFavouritesManager.removeFavourite(ApplicationUser user, SharedEntity entity)
boolean	FavouritesStore.removeFavourite(ApplicationUser user, SharedEntity entity) Remove Favourites association between User and entity
void	DefaultFavouritesManager.removeFavourite(com.atlassian.crowd.embedded.api.User user, SharedEntity entity)
void	OfBizFavouritesStore.removeFavouritesForEntity(SharedEntity entity)
void	CachingFavouritesStore.removeFavouritesForEntity(SharedEntity entity)
void	FavouritesStore.removeFavouritesForEntity(SharedEntity entity) Remove all favourite associations for a given entity.
void	DefaultFavouritesManager.removeFavouritesForEntityDelete(SharedEntity entity)
void	FavouritesManager.removeFavouritesForEntityDelete(SharedEntity entity) Remove all favourite associations for a given entity for entity deletion.

Method parameters in com.atlassian.jira.favourites with type arguments of type SharedEntity

Modifier and Type	Method and Description
Collection<Long>	DefaultFavouritesManager.getFavouriteIds(ApplicationUser user, SharedEntity.TypeDescriptor<SharedEntity> entityType)
Collection<Long>	DefaultFavouritesManager.getFavouriteIds(com.atlassian.crowd.embedded.api.User user, SharedEntity.TypeDescriptor<SharedEntity> entityType)
void	DefaultFavouritesManager.removeFavouritesForUser(ApplicationUser user, SharedEntity.TypeDescriptor<SharedEntity> entityType)
void	DefaultFavouritesManager.removeFavouritesForUser(com.atlassian.crowd.embedded.api.User user, SharedEntity.TypeDescriptor<SharedEntity> entityType)
void	OfBizFavouritesStore.updateSequence(ApplicationUser user, List<? extends SharedEntity> favouriteEntities)
void	CachingFavouritesStore.updateSequence(ApplicationUser user, List<? extends SharedEntity> favouriteEntities)
void	FavouritesStore.updateSequence(ApplicationUser user, List<? extends SharedEntity> favouriteEntities) Called to update the sequence of a list of favourite shared entities

Uses of SharedEntity in com.atlassian.jira.index.ha

Methods in com.atlassian.jira.index.ha that return types with arguments of type SharedEntity

Modifier and Type	Method and Description
Collection<SharedEntity>	SharedEntityResolver.getDummySharedEntities(SharedEntityType entityType, Set<Long> ids) Returns a set of 'placeholder' SharedEntity's - they only have an id
Collection<SharedEntity>	SharedEntityResolver.getSharedEntities(SharedEntityType entityType, Set<Long> ids) Returns a collection of SharedEntity's given ids

Methods in com.atlassian.jira.index.ha with parameters of type SharedEntity

Modifier and Type	Method and Description
void	DefaultReplicatedIndexManager.deIndexSharedEntity(SharedEntity entity) Deindexes the shared entity in the replicated index.
void	ReplicatedIndexManager.deIndexSharedEntity(SharedEntity entity)
void	DefaultReplicatedIndexManager.indexSharedEntity(SharedEntity entity) Reindexes the shared entity in the replicated index.
void	ReplicatedIndexManager.indexSharedEntity(SharedEntity entity)

Uses of SharedEntity in com.atlassian.jira.issue.search

Classes in com.atlassian.jira.issue.search that implement SharedEntity

Modifier and Type	Class and Description
class	MockJqlSearchRequest A mock search request to use when testing JQL code.
class	SearchRequest A shareable representation of a search for issues.

Methods in com.atlassian.jira.issue.search that return types with arguments of type SharedEntity

Modifier and Type	Method and Description
EnclosedIterable<SharedEntity>	DefaultSearchRequestManager.getAllIndexableSharedEntities()

Methods in com.atlassian.jira.issue.search with parameters of type SharedEntity

Modifier and Type	Method and Description
void	DefaultSearchRequestManager.adjustFavouriteCount(SharedEntity entity, int adjustmentValue)

Uses of SharedEntity in com.atlassian.jira.portal

Classes in com.atlassian.jira.portal that implement SharedEntity

Modifier and Type	Class and Description
class	PortalPage This class represents a Dashboard page in JIRA.

Methods in com.atlassian.jira.portal that return types with arguments of type SharedEntity

Modifier and Type	Method and Description
EnclosedIterable<SharedEntity>	DefaultPortalPageManager.getAllIndexableSharedEntities()

Methods in com.atlassian.jira.portal with parameters of type SharedEntity

Modifier and Type	Method and Description
PortalPage	PortalPageStore.adjustFavouriteCount(SharedEntity portalPage, int incrementValue) Updates the favourite count of the PortalPage in the database.
void	DefaultPortalPageManager.adjustFavouriteCount(SharedEntity entity, int adjustmentValue)
PortalPage	CachingPortalPageStore.adjustFavouriteCount(SharedEntity portalPage, int incrementValue)
PortalPage	OfBizPortalPageStore.adjustFavouriteCount(SharedEntity portalPage, int incrementValue)

Uses of SharedEntity in com.atlassian.jira.portal.events

Fields in com.atlassian.jira.portal.events declared as SharedEntity

Modifier and Type	Field and Description
SharedEntity	DashboardDeleted.dashboard

Constructors in com.atlassian.jira.portal.events with parameters of type SharedEntity

Constructor and Description
DashboardDeleted(SharedEntity deleted, com.atlassian.crowd.embedded.api.User user)

Uses of SharedEntity in com.atlassian.jira.sharing

Classes in com.atlassian.jira.sharing with type parameters of type SharedEntity

Modifier and Type	Class and Description
class	IndexableSharedEntity<S extends SharedEntity> Represents a SharedEntity in a lightweight way that can be used for indexing.
static class	SharedEntity.TypeDescriptor<S extends SharedEntity> The name and type of a SharedEntity.
interface	SharedEntityAccessor<S extends SharedEntity> Provides an abstraction for accessing SharedEntity objects.

Classes in com.atlassian.jira.sharing that implement SharedEntity

Modifier and Type	Class and Description
class	IndexableSharedEntity<S extends SharedEntity> Represents a SharedEntity in a lightweight way that can be used for indexing.
static class	SharedEntity.Identifier Utility class for identifying a SharedEntity.

Methods in com.atlassian.jira.sharing with type parameters of type SharedEntity

Modifier and Type	Method and Description
<S extends SharedEntity> SharedEntity.TypeDescriptor<S>	SharedEntity.TypeDescriptor.Factory.create(String name) should only be called by types that implement SharedEntity
<S extends SharedEntity> SharedEntity.TypeDescriptor<S>	SharedEntity.getEntityType() The type of entity it is.
<S extends SharedEntity> SharedEntityAccessor<S>	DefaultSharedEntityAccessorFactory.getSharedEntityAccessor(SharedEntity.TypeDescriptor<S> type)
<S extends SharedEntity> SharedEntityAccessor<S>	SharedEntityAccessor.Factory.getSharedEntityAccessor(SharedEntity.TypeDescriptor<S> type) Retrieves a SharedEntityAccessor that can operate on the passed type.
<S extends SharedEntity> SharedEntityAccessor<S>	DefaultSharedEntityAccessorFactory.getSharedEntityAccessor(String type)
<S extends SharedEntity> SharedEntityAccessor<S>	SharedEntityAccessor.Factory.getSharedEntityAccessor(String type) Retrieves a SharedEntityAccessor that can operate on the passed type.
<S extends SharedEntity> SharedEntity.TypeDescriptor<S>	SharedEntity.TypeDescriptor.Factory.register(SharedEntity.TypeDescriptor<S> typeDescriptor)

Methods in com.atlassian.jira.sharing that return types with arguments of type SharedEntity

Modifier and Type	Method and Description
EnclosedIterable<SharedEntity>	SharedEntityAccessor.getAllIndexableSharedEntities() Get all sharable entities this accessor can see for use in indexing.
SharedEntity.TypeDescriptor<SharedEntity>	SharedEntity.Identifier.getEntityType()

Methods in com.atlassian.jira.sharing with parameters of type SharedEntity

Modifier and Type	Method and Description
void	SharedEntityAccessor.adjustFavouriteCount(SharedEntity entity, int adjustmentValue) Adjusts the favourite counts for a given entity.
void	DefaultShareManager.deletePermissions(SharedEntity entity)
void	ShareManager.deletePermissions(SharedEntity entity) Delete all permissions associated with an entity
int	OfBizSharePermissionStore.deleteSharePermissions(SharedEntity entity)
int	CachingSharePermissionStore.deleteSharePermissions(SharedEntity entity)
int	SharePermissionStore.deleteSharePermissions(SharedEntity entity) Delete all SharePermission instances associate with given entity.
SharedEntity.SharePermissions	OfBizSharePermissionStore.getSharePermissions(SharedEntity entity)
SharedEntity.SharePermissions	CachingSharePermissionStore.getSharePermissions(SharedEntity entity)
SharedEntity.SharePermissions	SharePermissionStore.getSharePermissions(SharedEntity entity) Retrieve all SharePermission instances associated with a given SharedEntity
SharedEntity.SharePermissions	DefaultShareManager.getSharePermissions(SharedEntity entity)
SharedEntity.SharePermissions	ShareManager.getSharePermissions(SharedEntity entity) Retrieve all SharePermission instances associated with a passed in SharedEntity
boolean	DefaultShareManager.hasPermission(com.atlassian.crowd.embedded.api.User user, SharedEntity entity) Deprecated.
boolean	ShareManager.hasPermission(com.atlassian.crowd.embedded.api.User user, SharedEntity entity) Deprecated. since 5.0 please use ShareManager.isSharedWith(com.atlassian.crowd.embedded.api.User, SharedEntity) to get the same logic. Permission checks should be done in the service layer according to this information.
boolean	DefaultShareManager.isSharedWith(ApplicationUser user, SharedEntity sharedEntity)
boolean	ShareManager.isSharedWith(ApplicationUser user, SharedEntity sharedEntity) Whether this entity has been shared with the specified user.
boolean	DefaultShareManager.isSharedWith(com.atlassian.crowd.embedded.api.User user, SharedEntity sharedEntity)
boolean	ShareManager.isSharedWith(com.atlassian.crowd.embedded.api.User user, SharedEntity sharedEntity) Whether this entity has been shared with the specified user.
boolean	DefaultShareTypeValidatorUtils.isValidSharePermission(JiraServiceContext context, SharedEntity entity)
boolean	ShareTypeValidatorUtils.isValidSharePermission(JiraServiceContext context, SharedEntity entity) Validates to see if a given Set of SharePermission is valid.
SharedEntity.SharePermissions	OfBizSharePermissionStore.storeSharePermissions(SharedEntity entity)
SharedEntity.SharePermissions	CachingSharePermissionStore.storeSharePermissions(SharedEntity entity)
SharedEntity.SharePermissions	SharePermissionStore.storeSharePermissions(SharedEntity entity) Associate given entity with passed in Collection SharePermission.
SharedEntity.SharePermissions	DefaultShareManager.updateSharePermissions(SharedEntity entity)
SharedEntity.SharePermissions	ShareManager.updateSharePermissions(SharedEntity entity) Updates the SharePermission associated with an entity.

Constructor parameters in com.atlassian.jira.sharing with type arguments of type SharedEntity

Constructor and Description
SharedEntity.Identifier(Long id, SharedEntity.TypeDescriptor<? extends SharedEntity> type, ApplicationUser owner)
SharedEntity.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.
SharedEntity.Identifier(Long id, SharedEntity.TypeDescriptor<? extends SharedEntity> type, com.atlassian.crowd.embedded.api.User owner) Deprecated. Use #Identifier(Long, com.atlassian.jira.sharing.SharedEntity.TypeDescriptor, com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.

Uses of SharedEntity in com.atlassian.jira.sharing.index

Classes in com.atlassian.jira.sharing.index with type parameters of type SharedEntity

Modifier and Type	Class and Description
class	DefaultSharedEntitySearcher<S extends SharedEntity> Default implementation of SharedEntitySearcher.

Methods in com.atlassian.jira.sharing.index with type parameters of type SharedEntity

Modifier and Type	Method and Description
<S extends SharedEntity> SharedEntitySearcher<S>	MockSharedEntityIndexer.getSearcher(SharedEntity.TypeDescriptor<S> type)
<S extends SharedEntity> SharedEntitySearcher<S>	SharedEntityIndexer.getSearcher(SharedEntity.TypeDescriptor<S> type) Get a SharedEntitySearcher for the specified SharedEntity.TypeDescriptor
<S extends SharedEntity> SharedEntitySearcher<S>	DefaultSharedEntityIndexer.getSearcher(SharedEntity.TypeDescriptor<S> type)

Methods in com.atlassian.jira.sharing.index with parameters of type SharedEntity

Modifier and Type	Method and Description
org.apache.lucene.document.Document	SharedEntityDocumentFactory.create(SharedEntity entity)
Index.Result	MockSharedEntityIndexer.deIndex(SharedEntity entity)
Index.Result	SharedEntityIndexer.deIndex(SharedEntity entity) Delete a document from the index.
Index.Result	DefaultSharedEntityIndexer.deIndex(SharedEntity entity)
DefaultSharedEntityIndexer.EntityDocument	DefaultSharedEntityIndexer.EntityDocumentFactory.get(SharedEntity entity) Get the DefaultSharedEntityIndexer.EntityDocument for the entity.
Collection<org.apache.lucene.document.Field>	IsSharedFieldFactory.getField(SharedEntity entity)
Collection<org.apache.lucene.document.Field>	ShareTypePermissionsFieldFactory.getField(SharedEntity entity)
Collection<org.apache.lucene.document.Field>	SharedEntityFieldFactory.getField(SharedEntity entity)
Collection<org.apache.lucene.document.Field>	SharedEntityFieldFactory.Default.getField(SharedEntity entity)
Index.Result	MockSharedEntityIndexer.index(SharedEntity entity)
Index.Result	SharedEntityIndexer.index(SharedEntity entity) Add or update a document in the index.
Index.Result	DefaultSharedEntityIndexer.index(SharedEntity entity)
Index.Result	MockSharedEntityIndexer.index(SharedEntity entity, boolean updateReplicatedIndex)
Index.Result	SharedEntityIndexer.index(SharedEntity entity, boolean updateReplicatedIndex) Add or update a document in the index.
Index.Result	DefaultSharedEntityIndexer.index(SharedEntity entity, boolean updateReplicatedIndex)

Method parameters in com.atlassian.jira.sharing.index with type arguments of type SharedEntity

Modifier and Type	Method and Description
Index.Result	MockSharedEntityIndexer.deIndex(Set<SharedEntity> sharedEntities, boolean updateReplicatedIndex)
Index.Result	SharedEntityIndexer.deIndex(Set<SharedEntity> sharedEntities, boolean updateReplicatedIndex) Delete multiple documents in the index
Index.Result	DefaultSharedEntityIndexer.deIndex(Set<SharedEntity> sharedEntities, boolean updateReplicatedIndex)
Index.Result	MockSharedEntityIndexer.index(Set<SharedEntity> sharedEntities, boolean updateReplicatedIndex)
Index.Result	SharedEntityIndexer.index(Set<SharedEntity> sharedEntities, boolean updateReplicatedIndex) Add or update multiple documents in the index
Index.Result	DefaultSharedEntityIndexer.index(Set<SharedEntity> sharedEntities, boolean updateReplicatedIndex)

Uses of SharedEntity in com.atlassian.jira.sharing.search

Classes in com.atlassian.jira.sharing.search with type parameters of type SharedEntity

Modifier and Type	Interface and Description
interface	SharedEntitySearcher<S extends SharedEntity> Perform searches for SharedEntity instances.
class	SharedEntitySearchResult<E extends SharedEntity> A pair that contains the result status of SharedEntity search.

Uses of SharedEntity in com.atlassian.jira.sharing.type

Methods in com.atlassian.jira.sharing.type with parameters of type SharedEntity

Modifier and Type	Method and Description
org.apache.lucene.document.Field	ProjectShareQueryFactory.getField(SharedEntity entity, SharePermission permission)
org.apache.lucene.document.Field	GlobalShareQueryFactory.getField(SharedEntity entity, SharePermission permission)
org.apache.lucene.document.Field	GroupShareQueryFactory.getField(SharedEntity entity, SharePermission permission)
org.apache.lucene.document.Field	PrivateShareQueryFactory.getField(SharedEntity entity, SharePermission permission)
org.apache.lucene.document.Field	ShareQueryFactory.getField(SharedEntity entity, SharePermission permission) Get the Field we will later search for.

Method parameters in com.atlassian.jira.sharing.type with type arguments of type SharedEntity

Modifier and Type	Method and Description
Map<String,String>	GroupShareTypeRenderer.getTranslatedTemplates(JiraAuthenticationContext authenticationContext, SharedEntity.TypeDescriptor<? extends SharedEntity> type, ShareTypeRenderer.RenderMode mode)
Map<String,String>	ProjectShareTypeRenderer.getTranslatedTemplates(JiraAuthenticationContext authenticationContext, SharedEntity.TypeDescriptor<? extends SharedEntity> type, ShareTypeRenderer.RenderMode mode)
Map<String,String>	GlobalShareTypeRenderer.getTranslatedTemplates(JiraAuthenticationContext authenticationContext, SharedEntity.TypeDescriptor<? extends SharedEntity> type, ShareTypeRenderer.RenderMode mode)
Map<String,String>	ShareTypeRenderer.getTranslatedTemplates(JiraAuthenticationContext userCtx, SharedEntity.TypeDescriptor<? extends SharedEntity> type, ShareTypeRenderer.RenderMode mode) Return map of key -> template that can be used to show a configured shares in Javascript.

Uses of SharedEntity in com.atlassian.jira.web.action.util.sharing

Classes in com.atlassian.jira.web.action.util.sharing with type parameters of type SharedEntity

Modifier and Type	Class and Description
class	SharedEntitySearchViewHelper<E extends SharedEntity> A class that makes searching for Shared Entities easier.