com.atlassian.jira.sharing.search

Interface SharedEntitySearchParameters

@PublicApi
public interface SharedEntitySearchParameters

Interface for the passing parameters when searching for SharedEntity instances.

Since:

v3.13

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SharedEntitySearchParameters.TextSearchMode A type safe enumeration for specify text searching mode.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description fragments to search for.
SharedEntitySearchContext	getEntitySearchContext() Returns the SharedEntitySearchContext under which this search is to be executed.
Boolean	getFavourite() Returns a tri-state Boolean indicating how favourites are to be searched.
String	getName() Returns the name fragments to search for.
ShareTypeSearchParameter	getShareTypeParameter() Returns the ShareTypeSearchParameter object to be used.
SharedEntityColumn	getSortColumn() Returns the SharedEntityColumn to sort the results by.
SharedEntitySearchParameters.TextSearchMode	getTextSearchMode() This controls how the text fragment parameters (name and description) are combined and searched.
String	getUserName() Returns the user name to search for.
boolean	isAscendingSort()

Method Detail

getName

String getName()

Returns the name fragments to search for. The string is broken into white-space delimited words and each word is used as a OR'ed partial match for the name. If this is null, then SharedEntity's will be returned without regard to their name.

Returns:

the name fragments to search for.

getDescription

String getDescription()

Returns the description fragments to search for. The string is broken into white-space delimited words and each word is used as a OR'ed partial match for the description. If this is null, then SharedEntity's will be returned without regard to their description.

Returns:

the description fragments to search for.

getTextSearchMode

SharedEntitySearchParameters.TextSearchMode getTextSearchMode()

This controls how the text fragment parameters (name and description) are combined and searched.

If this value is TextSearchMode.AND then the name AND the description will be used to match

if this value is TextSearchMode.OR then the name OR the description will be used to match

Returns:

one of TextSearchMode.AND or TextSearchMode.OR. A value of null will be considered as TextSearchMode.AND

getUserName

String getUserName()

Returns the user name to search for. If this is null, then SharedEntity's will be returned without regard to which user shared them.

Returns:

the user name to search for.

getFavourite

Boolean getFavourite()

Returns a tri-state Boolean indicating how favourites are to be searched.

• IF the Boolean is null, then it doesn't care if the SharedEntity is a favourite or not
• IF the Boolean is true, then only favourited SharedEntity are returned
• IF the Boolean is false, then only non favourited SharedEntity are returned

Returns:

a tri-state Boolean indicating how favourites are to be searched.

isAscendingSort

boolean isAscendingSort()

Returns:

true if the results should be sorted in ascending order

getSortColumn

SharedEntityColumn getSortColumn()

Returns the SharedEntityColumn to sort the results by. SharedEntityColumn.NAME will be used by default.

The following constants MUST be used

• SharedEntityColumn.DESCRIPTION
• SharedEntityColumn.FAVOURITE_COUNT
• SharedEntityColumn.ID
• SharedEntityColumn.NAME
• SharedEntityColumn.OWNER

Returns:

the SharedEntityColumn used for searching. It MUST not be null.

getShareTypeParameter

ShareTypeSearchParameter getShareTypeParameter()

Returns the ShareTypeSearchParameter object to be used. When this parameter is non null, then only SharedEntity's shared via that share type will be returned. If the value is null, then SharedEntity's will be returned without regard to how they were shared.

Returns:

the ShareTypeSearchParameter to use. It can be null.

getEntitySearchContext

SharedEntitySearchContext getEntitySearchContext()

Returns the SharedEntitySearchContext under which this search is to be executed. This can either be SharedEntitySearchContext.ADMINISTER or SharedEntitySearchContext.USE.

Returns:

the SharedEntitySearchContext under which this search is to be executed. Can not be null.