com.atlassian.jira.sharing

Interface SharedEntityAccessor<S extends SharedEntity>

All Known Subinterfaces:

PortalPageManager, SearchRequestManager

All Known Implementing Classes:

DefaultPortalPageManager, DefaultSearchRequestManager

public interface SharedEntityAccessor<S extends SharedEntity>

Provides an abstraction for accessing SharedEntity objects. This class abstracts away the details of the SharedEntity implementation to those components that need it.

Since:

v3.13

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SharedEntityAccessor.Factory Factory to retrieve a SharedEntityAccessor for a given SharedEntity
static interface	SharedEntityAccessor.RetrievalDescriptor Used when getting a Collection of shared entities.

Method Summary

Modifier and Type	Method and Description
void	adjustFavouriteCount(SharedEntity entity, int adjustmentValue) Adjusts the favourite counts for a given entity.
EnclosedIterable<S>	get(ApplicationUser searcher, SharedEntityAccessor.RetrievalDescriptor descriptor) Used to get sharable entities from a search result.
EnclosedIterable<S>	get(SharedEntityAccessor.RetrievalDescriptor descriptor) Used to get sharable entities from a search result.
EnclosedIterable<S>	getAll() Deprecated. This has been moved to the PortalPageManager and deprecated for SearchRequestManager. Since v5.2.
EnclosedIterable<SharedEntity>	getAllIndexableSharedEntities() Get all sharable entities this accessor can see for use in indexing.
S	getSharedEntity(ApplicationUser user, Long entityId) This is called to get SharedEntity by id If the user is allows to see it
S	getSharedEntity(Long entityId) This will call back to ask for a SharedEntity based on id.
SharedEntity.TypeDescriptor<S>	getType() Returns the type that this object can work with.
boolean	hasPermissionToUse(ApplicationUser user, S entity) Returns true if the user has permission to use the SharedEntity
SharedEntitySearchResult<S>	search(SharedEntitySearchParameters searchParameters, ApplicationUser user, int pagePosition, int pageWidth) Search for the sharable entities that match the passed SearchParameters.

Method Detail

getType

SharedEntity.TypeDescriptor<S> getType()

Returns the type that this object can work with.

Returns:

the type that this object can work with.

adjustFavouriteCount

void adjustFavouriteCount(SharedEntity entity,
                          int adjustmentValue)

Adjusts the favourite counts for a given entity. This resulting value must always be greater or equal to one.

Parameters:

entity - the entity to adjust

adjustmentValue - the value to adjust by.

getSharedEntity

S getSharedEntity(Long entityId)

This will call back to ask for a SharedEntity based on id.

Parameters:

entityId - the id of the SharedEntity

Returns:

a SharedEntity or null if it cant be found

getSharedEntity

S getSharedEntity(ApplicationUser user,
                  Long entityId)

This is called to get SharedEntity by id If the user is allows to see it

Parameters:

user - the user in play

entityId - the id of the SharedEntity

Returns:

a SharedEntity if it exists and the user can see it and null otherwise

hasPermissionToUse

boolean hasPermissionToUse(ApplicationUser user,
                           S entity)

Returns true if the user has permission to use the SharedEntity

Parameters:

user - the user in play

entity - the SharedEntity to check

Returns:

true if the user has permission to use it

getAll

EnclosedIterable<S> getAll()

Deprecated. This has been moved to the PortalPageManager and deprecated for SearchRequestManager. Since v5.2.

Get all sharable entities this accessor can see.

Returns:

a EnclosedIterable of SharedEntity's

getAllIndexableSharedEntities

EnclosedIterable<SharedEntity> getAllIndexableSharedEntities()

Get all sharable entities this accessor can see for use in indexing.

Returns:

a EnclosedIterable of SharedEntity's

get

EnclosedIterable<S> get(SharedEntityAccessor.RetrievalDescriptor descriptor)

Used to get sharable entities from a search result.

Parameters:

descriptor - retrieval descriptor

Returns:

a EnclosedIterable of SharedEntity's

get

EnclosedIterable<S> get(ApplicationUser searcher,
                        SharedEntityAccessor.RetrievalDescriptor descriptor)

Used to get sharable entities from a search result. The entities returned may be modified by the user parameter (e.g. permissions or clause sanitisation).

Parameters:

searcher - the user performing the search

descriptor - retrieval descriptor

Returns:

a EnclosedIterable of SharedEntity's

search

SharedEntitySearchResult<S> search(SharedEntitySearchParameters searchParameters,
                                   ApplicationUser user,
                                   int pagePosition,
                                   int pageWidth)

Search for the sharable entities that match the passed SearchParameters. The result can be paged so that a subset of the results can be returned.

Parameters:

searchParameters - the SearchParameters to query.

user - the user performing the search.

pagePosition - the page to return.

pageWidth - the number of results per page.

Returns:

the result containing the PortalPages objects that match the request.

Since:

v7.1