com.atlassian.jira.sharing.search
Interface SharedEntitySearchParameters


public interface SharedEntitySearchParameters

Interface for the passing parameters when searching for SharedEntity instances.

Since:
v3.13

Nested Class Summary
static class SharedEntitySearchParameters.TextSearchMode
          A type safe enumeration for specify text searching mode.
 
Method Summary
 java.lang.String getDescription()
          Returns the description fragments to search for.
 java.lang.Boolean getFavourite()
          Returns a tri-state Boolean indicating how favourites are to be searched.
 java.lang.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.
 java.lang.String getUserName()
          Returns the user name to search for.
 boolean isAscendingSort()
           
 

Method Detail

getName

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

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

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

java.lang.Boolean getFavourite()
Returns a tri-state Boolean indicating how favourites are to be searched.

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

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.

The following classes and singleton instances can be used

Returns:
the ShareTypeSearchParameter to use. It can be null.


Copyright © 2002-2011 Atlassian. All Rights Reserved.