@PublicApi
public interface SharedEntitySearchParameters
Modifier and Type | Interface and Description |
---|---|
static class |
SharedEntitySearchParameters.TextSearchMode
A type safe enumeration for specify text searching mode.
|
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() |
String getName()
String getDescription()
SharedEntitySearchParameters.TextSearchMode getTextSearchMode()
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
String getUserName()
Boolean getFavourite()
boolean isAscendingSort()
SharedEntityColumn getSortColumn()
SharedEntityColumn.NAME
will be used by default.
The following constants MUST be used
ShareTypeSearchParameter getShareTypeParameter()
SharedEntitySearchContext getEntitySearchContext()
SharedEntitySearchContext.ADMINISTER
or
SharedEntitySearchContext.USE
.Copyright © 2002-2022 Atlassian. All Rights Reserved.