@Deprecated public class

ProjectSearchCriteria

extends Object
java.lang.Object
   ↳ com.atlassian.stash.project.ProjectSearchCriteria
Known Direct Subclasses

This class is deprecated.
as of 2.6, scheduled for removal in 3.0. Use ProjectSearchRequest instead.

Class Overview

Criteria for searching projects. The purpose and behaviour of each field is described on its accessor.

Summary

Nested Classes
class ProjectSearchCriteria.Builder This class is deprecated. in 2.6, scheduled for removal in 3.0. Use ProjectSearchRequest.Builder instead.  
Public Methods
@Nullable String getName()
When set, limits returned projects to only those whose names contain the provided value.
@Nullable Permission getPermission()
When set, limits returned projects to only those for which the current user has the required Permission.
boolean hasName()
Retrieves a flag indicating whether name text has been set.
boolean hasPermission()
Retrieves a flag indicating whether a specific permission has been set.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

@Nullable public String getName ()

When set, limits returned projects to only those whose names contain the provided value. Matching is performed in a case-insensitive manner, and will match anywhere within projects' names.

Note: Values containing only whitespace are ignored, and will not be applied. Additionally, leading and trailing whitespace are trimmed.

Returns
  • filter text match against project names, or null to return projects regardless of name

@Nullable public Permission getPermission ()

When set, limits returned projects to only those for which the current user has the required Permission. The provided value may be null, in which case projects will automatically be limited to those for which the current user has VIEW permission.

Returns
  • the required permission, or null to default to VIEW

public boolean hasName ()

Retrieves a flag indicating whether name text has been set.

Returns
  • true if getName() is not null or whitespace; otherwise, false

public boolean hasPermission ()

Retrieves a flag indicating whether a specific permission has been set. If no explicit permission has been set, the search will default to VIEW.

Returns