GscopeByQueryConsumer (Plugin Shared 16.24.0-SNAPSHOT API)

```
public interface GscopeByQueryConsumer
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`applyGscopeWhenQueryMatches(String gscopeName, String query)`	A plugin may call this to supply a gscope which should be set for all documents that match the query.

- Method Detail
  - applyGscopeWhenQueryMatches
```
void applyGscopeWhenQueryMatches(String gscopeName,
                                 String query)
                          throws IllegalArgumentException
```
    A plugin may call this to supply a gscope which should be set for all documents that match the query.
    
    Parameters:
    
    gscopeName - The name the gscope to set. Limited to ASCII alpha numeric characters and must be no longer than 64 characters. Additionally gscope names which start with 'Fun' in any upper or lower case form are reserved for internal use.
    
    query - The query which will be run.
    
    Throws:
    
    IllegalArgumentException - when one or more of the arguments is not valid.