Package com.illumon.iris.controller

Interface PersistentQueryScriptSource

All Superinterfaces:

RemoteScriptSource

All Known Implementing Classes:

PersistentQueryControllerClient

public interface PersistentQueryScriptSource
extends RemoteScriptSource

A RemoteScriptSource that can load paths for a specific serial ID.

Method Summary

Modifier and Type	Method	Description
default String	getScriptBody(boolean relative, String scriptPath, long configSerial)	Get a script by path for a specific serial ID.
String	getScriptBody(boolean relative, String scriptPath, long configSerial, ScriptPathLoaderState scriptLoaderState)	Get a script by path for a specific serial ID and a specific state.
default Set<String>	getScriptDisplayPaths(long configSerial)	Get all display paths available to a specific PersistentQuery serial ID.
Set<String>	getScriptDisplayPaths(long configSerial, ScriptPathLoaderState scriptLoaderState)	Get all display paths available to a specific PersistentQuery serial ID and a specific state..

Methods inherited from interface com.illumon.iris.controller.RemoteScriptSource

getScriptBody, getScriptBody, getScriptBodyByOwner, getScriptBodyByOwner, getScriptDisplayPaths, getScriptDisplayPaths, getScriptDisplayPathsByOwner, getScriptDisplayPathsByOwner

Method Details

getScriptDisplayPaths

default Set<String> getScriptDisplayPaths(long configSerial)

Get all display paths available to a specific PersistentQuery serial ID.

Parameters:

configSerial - A serial ID.

Returns:

The paths available to the serial ID.

getScriptDisplayPaths

Set<String> getScriptDisplayPaths(long configSerial,
 @Nullable
 ScriptPathLoaderState scriptLoaderState)

Get all display paths available to a specific PersistentQuery serial ID and a specific state..

Parameters:

configSerial - A serial ID.

scriptLoaderState - A specific state to retrieve scripts from or ScriptPathLoaderState.NONE to get the latest version.

Returns:

The paths available to the serial ID.

getScriptBody

default String getScriptBody(boolean relative,
 @NotNull
 String scriptPath,
 long configSerial)

Get a script by path for a specific serial ID.

Parameters:

relative - Is the path a relative path?

scriptPath - The path string.

configSerial - The Serial ID.

Returns:

The contents of the script.

getScriptBody

String getScriptBody(boolean relative,
 String scriptPath,
 long configSerial,
 @Nullable
 ScriptPathLoaderState scriptLoaderState)

Get a script by path for a specific serial ID and a specific state.

Parameters:

relative - Is the path a relative path?

scriptPath - The path string.

configSerial - The Serial ID.

scriptLoaderState - A specific state to retrieve scripts from or ScriptPathLoaderState.NONE to get the latest version.

Returns:

The contents of the script.