Package hec.script

Interface ScriptManager

public interface ScriptManager

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BG_COLOR
static final String	DESCRIPTION
static final String	DISPLAY_IN_MENU
static final String	DISPLAY_IN_SELECTOR
static final String	DISPLAY_TO_USER
static final String	GROUP
static final String	ICON_NAME
static final String	NAME	recognized fields in the comments section of the .py file

Method Summary

Modifier and Type	Method	Description
void	addConfigChangeListener(ConfigChangeListener listener)
String	checkLockedBy(String scriptPath)
void	close()
boolean	deleteScript(ScriptIdentifier sid)
boolean	deleteScript(ScriptIdentifier sid, boolean notify)
boolean	deleteScript(ScriptIdentifier sid, boolean notify, boolean warnUser)
boolean	downLoadModule(String moduleName)
Hashtable	getCache()
Identifier	getIdFromScriptId(ScriptIdentifier sid)
String	getPathFromTreePath(String treePath)
Script	getScript(ScriptIdentifier sid)
Vector	getScriptIdsForMode(String moduleName)
Vector	getScriptIdsForObject(String scriptIdPath)
boolean	isUniqueScriptName(String s)
boolean	isUniqueScriptName(String s, Hashtable cache)
boolean	lockScriptFile(boolean lock, String scriptPath)
void	reloadScript(ScriptIdentifier sid)
void	removeConfigChangeListener(ConfigChangeListener listener)
boolean	saveScript(ScriptIdentifier sid, Script script)
void	scriptAdded(ScriptIdentifier sid)

Field Details

NAME

static final String NAME

recognized fields in the comments section of the .py file

See Also:

• Constant Field Values

DESCRIPTION

static final String DESCRIPTION

See Also:

• Constant Field Values

DISPLAY_IN_MENU

static final String DISPLAY_IN_MENU

See Also:

• Constant Field Values

DISPLAY_TO_USER

static final String DISPLAY_TO_USER

See Also:

• Constant Field Values

DISPLAY_IN_SELECTOR

static final String DISPLAY_IN_SELECTOR

See Also:

• Constant Field Values

ICON_NAME

static final String ICON_NAME

See Also:

• Constant Field Values

BG_COLOR

static final String BG_COLOR

See Also:

• Constant Field Values

GROUP

static final String GROUP

See Also:

• Constant Field Values

Method Details

close

void close()

getScript

Script getScript(ScriptIdentifier sid)

deleteScript

boolean deleteScript(ScriptIdentifier sid)

getScriptIdsForMode

Vector getScriptIdsForMode(String moduleName)

downLoadModule

boolean downLoadModule(String moduleName)

getIdFromScriptId

Identifier getIdFromScriptId(ScriptIdentifier sid)

reloadScript

void reloadScript(ScriptIdentifier sid)

scriptAdded

void scriptAdded(ScriptIdentifier sid)

deleteScript

boolean deleteScript(ScriptIdentifier sid,
 boolean notify)

deleteScript

boolean deleteScript(ScriptIdentifier sid,
 boolean notify,
 boolean warnUser)

lockScriptFile

boolean lockScriptFile(boolean lock,
 String scriptPath)

checkLockedBy

String checkLockedBy(String scriptPath)

getPathFromTreePath

String getPathFromTreePath(String treePath)

addConfigChangeListener

void addConfigChangeListener(ConfigChangeListener listener)

removeConfigChangeListener

void removeConfigChangeListener(ConfigChangeListener listener)

isUniqueScriptName

boolean isUniqueScriptName(String s)

saveScript

boolean saveScript(ScriptIdentifier sid,
 Script script)

getScriptIdsForObject

Vector getScriptIdsForObject(String scriptIdPath)

getCache

Hashtable getCache()

isUniqueScriptName

boolean isUniqueScriptName(String s,
 Hashtable cache)