public class

SharedEntitySearchParametersBuilder

extends Object
java.lang.Object
   ↳ com.atlassian.jira.sharing.search.SharedEntitySearchParametersBuilder

Class Overview

A builder object used to create searching parameters when looking for SharedEntityColumn instances.

This has a toSearchParameters() method that gives back a new immutable instance of SharedEntitySearchParameters when called.

See Also

Summary

Public Constructors
SharedEntitySearchParametersBuilder()
Creates a new template with empty parameters.
SharedEntitySearchParametersBuilder(SharedEntitySearchParameters sharedEntitySearchParameters)
Creates a new template based on the parameters contained within an existing SharedEntitySearchParameters instance
Public Methods
SharedEntitySearchParametersBuilder setDescription(String description)
SharedEntitySearchParametersBuilder setEntitySearchContext(SharedEntitySearchContext entitySearchContext)
SharedEntitySearchParametersBuilder setFavourite(Boolean favourite)
SharedEntitySearchParametersBuilder setName(String name)
SharedEntitySearchParametersBuilder setSharePermission(SharePermission permission)
SharedEntitySearchParametersBuilder setShareTypeParameter(ShareTypeSearchParameter shareTypeParameter)
Sets the Share Type parameter, used to search for shared entities that are shared based

The following classes and singleton instances can be used

SharedEntitySearchParametersBuilder setSortColumn(SharedEntityColumn column, boolean sortOrderAscending)
SharedEntitySearchParametersBuilder setTextSearchMode(SharedEntitySearchParameters.TextSearchMode textSearchMode)
SharedEntitySearchParametersBuilder setUserName(String user)
SharedEntitySearchParameters toSearchParameters()
Call this method to clone the current SharedEntitySearchParametersTemplate into an immutable SharedEntitySearchParameters object.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SharedEntitySearchParametersBuilder ()

Creates a new template with empty parameters. This will find the most data possible in this state

See Also

public SharedEntitySearchParametersBuilder (SharedEntitySearchParameters sharedEntitySearchParameters)

Creates a new template based on the parameters contained within an existing SharedEntitySearchParameters instance

Parameters
sharedEntitySearchParameters the existing SharedEntitySearchParameters object. Must be non null.
Throws
IllegalArgumentException if the sharedEntitySearchParameters is null.
See Also

Public Methods

public SharedEntitySearchParametersBuilder setDescription (String description)

public SharedEntitySearchParametersBuilder setEntitySearchContext (SharedEntitySearchContext entitySearchContext)

public SharedEntitySearchParametersBuilder setFavourite (Boolean favourite)

public SharedEntitySearchParametersBuilder setName (String name)

public SharedEntitySearchParametersBuilder setSharePermission (SharePermission permission)

public SharedEntitySearchParametersBuilder setShareTypeParameter (ShareTypeSearchParameter shareTypeParameter)

Sets the Share Type parameter, used to search for shared entities that are shared based

The following classes and singleton instances can be used

Parameters
shareTypeParameter the ShareTypeSearchParameter
Returns
  • this Builder

public SharedEntitySearchParametersBuilder setSortColumn (SharedEntityColumn column, boolean sortOrderAscending)

public SharedEntitySearchParametersBuilder setTextSearchMode (SharedEntitySearchParameters.TextSearchMode textSearchMode)

public SharedEntitySearchParametersBuilder setUserName (String user)

public SharedEntitySearchParameters toSearchParameters ()

Call this method to clone the current SharedEntitySearchParametersTemplate into an immutable SharedEntitySearchParameters object. This immutable object can then safely be shared between threads and placed into the Session for example.

Returns
  • an im0mutable SharedEntitySearchParameters object.

public String toString ()