SearchDelegator (p4java 2024.1.2612262 API)

java.lang.Object
- com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator
- - com.perforce.p4java.impl.mapbased.server.cmd.SearchDelegator

All Implemented Interfaces:

ISearchDelegator
```
public class SearchDelegator
extends BaseDelegator
implements ISearchDelegator
```
Implementation to handle the Search command.

Field Summary
- Fields inherited from class com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator
  MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION

Constructor Summary

Constructors
Constructor	Description
`SearchDelegator(IOptionsServer server)`	Instantiate a new SearchDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<java.lang.String>`	`searchJobs(java.lang.String words, SearchJobsOptions opts)`	Search for jobs that contain the specified words in the search engine's index.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SearchDelegator
```
public SearchDelegator(IOptionsServer server)
```
    Instantiate a new SearchDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.
    
    Parameters:
    
    server - a concrete implementation of a Perforce Helix Server
- Method Detail
  - searchJobs
```
public java.util.List<java.lang.String> searchJobs(java.lang.String words,
                                                   SearchJobsOptions opts)
                                            throws P4JavaException
```
    Description copied from interface: ISearchDelegator
    
    Search for jobs that contain the specified words in the search engine's index.
    Note that this is an 'undoc' Perforce command.
    See also 'p4 help index'.
    
    Specified by:
    
    searchJobs in interface ISearchDelegator
    
    Parameters:
    
    words - non-null words to be searched.
    
    opts - SearchJobsOptions object describing optional parameters; if null, no options are set.
    
    Returns:
    
    non-null (but possibly-empty) list of job IDs.
    
    Throws:
    
    P4JavaException - if an error occurs processing this method and its parameters.