com.atlassian.jira.functest.framework.backdoor
Class SearchRequestControl

java.lang.Object
  extended by com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient<T>
      extended by com.atlassian.jira.functest.framework.backdoor.BackdoorControl<SearchRequestControl>
          extended by com.atlassian.jira.functest.framework.backdoor.SearchRequestControl
All Implemented Interfaces:
FuncTestLogger

public class SearchRequestControl
extends BackdoorControl<SearchRequestControl>

Use this class from func/selenium/page-object tests that need to manipulate SearchRequests. See SearchRequestBackdoor for the code this plugs into at the back-end.

Since:
v5.0

Nested Class Summary
static class SearchRequestControl.SearchBean
           
 
Nested classes/interfaces inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient
RestApiClient.Method
 
Field Summary
 
Fields inherited from class com.atlassian.jira.functest.framework.backdoor.BackdoorControl
restPathRootLength
 
Fields inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient
REST_VERSION
 
Constructor Summary
SearchRequestControl(JIRAEnvironmentData environmentData)
           
 
Method Summary
 String createFilter(String username, String searchJql, String searchName, String searchDescription)
          Creates a SearchRequest with the specified query and returns the id of the object created.
 String createFilter(String username, String searchJql, String searchName, String searchDescription, String jsonShareString)
          Creates a SearchRequest with the specified query and returns the id of the object created.
 List<SearchRequestControl.SearchBean> getOwnedFilters(String username)
           
 
Methods inherited from class com.atlassian.jira.functest.framework.backdoor.BackdoorControl
createResource, delete, get, get, get, getId, log, log, post
 
Methods inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient
anonymous, errorResponse, expanded, loginAs, loginAs, percentEncode, resourceRoot, setOf, toResponse, toResponse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchRequestControl

public SearchRequestControl(JIRAEnvironmentData environmentData)
Method Detail

createFilter

public String createFilter(String username,
                           String searchJql,
                           String searchName,
                           String searchDescription)
Creates a SearchRequest with the specified query and returns the id of the object created. The share level of the filter will be Private.

Parameters:
username - the user to save the search for
searchJql - the JQL of the search
searchName - the name of the search
searchDescription - the description of the search
Returns:
String id of the SearchRequest created

createFilter

public String createFilter(String username,
                           String searchJql,
                           String searchName,
                           String searchDescription,
                           String jsonShareString)
Creates a SearchRequest with the specified query and returns the id of the object created. The share level of the filter will be determined by the JSON share string. See SharePermissionUtils for how the JSON is handled.

Parameters:
username - the user to save the search for
searchJql - the JQL of the search
searchName - the name of the search
searchDescription - the description of the search
jsonShareString - a JSON array of permissions to apply to the saved search
Returns:
String id of the SearchRequest created

getOwnedFilters

public List<SearchRequestControl.SearchBean> getOwnedFilters(String username)


Copyright © 2002-2012 Atlassian. All Rights Reserved.