Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface ScriptingCommand

All Superinterfaces:

Reference

@Plural("scripting commands")
@Code("sdcm")
@Name("scripting command")
public interface ScriptingCommand
extends Reference

A command within a suite within a scripting definition.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
default int	countScriptingParameters()
int	countScriptingParameters(String filter)
String	getDescription()	The description of the command.
ScriptingParameter	getDirectParameter()	The direct parameter of the command.
String	getId()	The unique identifier of the command.
String	getName()	The name of the command.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
ScriptingParameter	getScriptingParameter(int index)
ScriptingParameter	getScriptingParameter(Id id)
default ScriptingParameter[]	getScriptingParameters()
ScriptingParameter[]	getScriptingParameters(String filter)
ScriptingResultObject	getScriptingResult()	The object or data returned by this command.
String	getSuiteName()	The name of the suite to which this command belongs.
boolean	isHidden()	Is the command hidden?

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getScriptingParameters

@Kind("element")
@Type("scripting parameter")
default ScriptingParameter[] getScriptingParameters()

Returns:

an array of all ScriptingParameters

getScriptingParameters

@Kind("element")
@Type("scripting parameter")
ScriptingParameter[] getScriptingParameters(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all ScriptingParameters

getScriptingParameter

@Kind("element")
@Type("scripting parameter")
ScriptingParameter getScriptingParameter(int index)

Parameters:

index - index into the element list (zero-based)

Returns:

the ScriptingParameter at the requested index

getScriptingParameter

@Kind("element")
@Type("scripting parameter")
ScriptingParameter getScriptingParameter(Id id)

Parameters:

id - id of the item

Returns:

the ScriptingParameter with the requested id

countScriptingParameters

@Kind("element")
@Type("scripting parameter")
default int countScriptingParameters()

Returns:

number of all ScriptingParameters

countScriptingParameters

@Kind("element")
@Type("scripting parameter")
int countScriptingParameters(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getName

@Code("pnam")
@Kind("property")
@Name("name")
@Type("text")
String getName()

The name of the command.

Returns:

property value

getId

@Code("ID  ")
@Kind("property")
@Name("id")
@Type("text")
String getId()

The unique identifier of the command.

Returns:

property value

getDescription

@Code("desc")
@Kind("property")
@Name("description")
@Type("text")
String getDescription()

The description of the command.

Returns:

property value

getDirectParameter

@Code("sddp")
@Kind("property")
@Name("direct parameter")
@Type("scripting parameter")
ScriptingParameter getDirectParameter()

The direct parameter of the command.

Returns:

property value

isHidden

@Code("hidn")
@Kind("property")
@Name("hidden")
@Type("boolean")
boolean isHidden()

Is the command hidden?

Returns:

property value

getScriptingResult

@Code("sdrs")
@Kind("property")
@Name("scripting result")
@Type("scripting result object")
ScriptingResultObject getScriptingResult()

The object or data returned by this command.

Returns:

property value

getSuiteName

@Code("stnm")
@Kind("property")
@Name("suite name")
@Type("text")
String getSuiteName()

The name of the suite to which this command belongs.

Returns:

property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties