java.lang.Object | |
↳ | com.atlassian.jira.issue.search.SearchRequest |
Known Direct Subclasses |
Clients of @PublicApi
can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicApi
as per each product's API policy as long as the client does not implement/extend
@PublicApi
interfaces or classes (refer to each product's API policy for the exact
guarantee---usually binary compatibility is guaranteed at least across minor versions).
@PublicApi
interfaces and classes are not designed to be implemented or extended by clients,
we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not
affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces
annotated with @PublicSpi
are safe to extend/implement).
A shareable representation of a search for issues. Officially known as a "Filter" or "Saved Filter".
This class binds the Query
, which is used to perform the actual search, and
the saved information (such as name, description), and any permissions that may be associated with the saved search
together.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
ENTITY_TYPE |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
A no-arg constructor that will build a SearchRequest with an empty
Query , this
will be a search that will find all issues with the default system sorting . | |||||||||||
Creates a SearchRequest with the specified
Query and no other attributes. | |||||||||||
Used to create a SearchRequest that copies all the information from the old search request.
| |||||||||||
Build a SearchRequest with the provided attributes, this can be used if you want to create a SearchRequest that
can be persisted.
| |||||||||||
Build a SearchRequest with the provided attributes.
| |||||||||||
This constructor is deprecated.
Use
SearchRequest(com.atlassian.query.Query, com.atlassian.jira.user.ApplicationUser, String, String) instead. Since v6.0.
Build a SearchRequest with the provided attributes, this can be used if you want to create a SearchRequest that
can be persisted. | |||||||||||
This constructor is deprecated.
Use
SearchRequest(com.atlassian.query.Query, com.atlassian.jira.user.ApplicationUser, String, String, Long, long) instead. Since v6.0.
Build a SearchRequest with the provided attributes. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
A general description of the entity.
| |||||||||||
The type of entity it is.
| |||||||||||
The number of users who have marked this entity as one of their favourites.
| |||||||||||
The id of the entity.
| |||||||||||
The name of the entity.
| |||||||||||
The permissions for this entity.
| |||||||||||
Gets the SearchQuery that defines the search that will be performed for this SearchRequest.
| |||||||||||
Set the owner of the SearchRequest.
| |||||||||||
This method is deprecated.
Use
setOwner(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.
Set the owner of the SearchRequest. | |||||||||||
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.jira.favourites.Favourite
| |||||||||||
From interface com.atlassian.jira.sharing.SharedEntity |
A no-arg constructor that will build a SearchRequest with an empty Query
, this
will be a search that will find all issues with the default system sorting . You can then use the setter methods
to set the attributes you wish this SearchRequest to contain.
Creates a SearchRequest with the specified Query
and no other attributes.
This can be used to create a programtic SearchRequest that can be used to perform a search but is not ready to
be saved.
query | provides the details of the search that will be performed with this SearchRequest. |
---|
Used to create a SearchRequest that copies all the information from the old search request. This includes the name, description, author, id, favCount and the SearchQuery.
oldRequest | defines all the attributes that this SearchRequest will contain. |
---|
Build a SearchRequest with the provided attributes, this can be used if you want to create a SearchRequest that can be persisted.
query | defines what this SearchRequest will search for. |
---|---|
owner | the owner, user who initially create the request. |
name | the name associated with this SearchRequest, can be set even if this is not persistent yet. |
description | the description associated with this SearchRequest, can be set even if this is not persistent yet. filter. |
Build a SearchRequest with the provided attributes.
query | defines what this SearchRequest will search for. |
---|---|
owner | the owner, user who initially create the request. |
name | the name associated with this SearchRequest, can be set even if this is not persistent yet. |
description | the description associated with this SearchRequest, can be set even if this is not persistent yet. |
id | the persistent id of the SearchRequest, null if the SearchRequest is not persistent. |
favouriteCount | the number of users that have this filter as a favortie, will only be set if this is a persistent filter. |
This constructor is deprecated.
Use SearchRequest(com.atlassian.query.Query, com.atlassian.jira.user.ApplicationUser, String, String)
instead. Since v6.0.
Build a SearchRequest with the provided attributes, this can be used if you want to create a SearchRequest that
can be persisted.
query | defines what this SearchRequest will search for. |
---|---|
ownerUserName | the owner, user who initially create the request. |
name | the name associated with this SearchRequest, can be set even if this is not persistent yet. |
description | the description associated with this SearchRequest, can be set even if this is not persistent yet. filter. |
This constructor is deprecated.
Use SearchRequest(com.atlassian.query.Query, com.atlassian.jira.user.ApplicationUser, String, String, Long, long)
instead. Since v6.0.
Build a SearchRequest with the provided attributes.
query | defines what this SearchRequest will search for. |
---|---|
ownerUserName | the owner, user who initially create the request. |
name | the name associated with this SearchRequest, can be set even if this is not persistent yet. |
description | the description associated with this SearchRequest, can be set even if this is not persistent yet. |
id | the persistent id of the SearchRequest, null if the SearchRequest is not persistent. |
favouriteCount | the number of users that have this filter as a favortie, will only be set if this is a persistent filter. |
A general description of the entity.
The type of entity it is. Examples include SearchRequest ("SearchRequest") and PortalPage ("PortalPage")
The number of users who have marked this entity as one of their favourites.
The id of the entity.
The permissions for this entity.
Gets the SearchQuery that defines the search that will be performed for this SearchRequest.
Set the owner of the SearchRequest.
owner | the user who is the search requests owner. |
---|
This method is deprecated.
Use setOwner(com.atlassian.jira.user.ApplicationUser)
instead. Since v6.0.
Set the owner of the SearchRequest.
ownerUserName | the name of the user who is the search requests owner. |
---|