Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface Service

All Superinterfaces:

Reference

@Plural("services")
@Code("svce")
@Name("service")
public interface Service
extends Reference

A collection of settings for a network service.

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	countConfigurations()
int	countConfigurations(String filter)
Configuration	getConfiguration(int index)
Configuration	getConfiguration(Id id)
default Configuration[]	getConfigurations()
Configuration[]	getConfigurations(String filter)
Configuration	getCurrentConfiguration()	The currently selected configuration.
String	getId()	The unique identifier for the service.
Interface	getInterface()	The interface the service is built on.
int	getKind()	The type of service.
String	getName()	The name of the service.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
boolean	isActive()	Is the service active?
void	setCurrentConfiguration(Configuration currentConfiguration)	The currently selected configuration.
void	setName(String name)	The name of the service.

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getConfigurations

@Kind("element")
@Type("configuration")
default Configuration[] getConfigurations()

Returns:

an array of all Configurations

getConfigurations

@Kind("element")
@Type("configuration")
Configuration[] getConfigurations(String filter)

Parameters:

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

Returns:

an array of all Configurations

getConfiguration

@Kind("element")
@Type("configuration")
Configuration getConfiguration(int index)

Parameters:

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

Returns:

the Configuration at the requested index

getConfiguration

@Kind("element")
@Type("configuration")
Configuration getConfiguration(Id id)

Parameters:

id - id of the item

Returns:

the Configuration with the requested id

countConfigurations

@Kind("element")
@Type("configuration")
default int countConfigurations()

Returns:

number of all Configurations

countConfigurations

@Kind("element")
@Type("configuration")
int countConfigurations(String filter)

Parameters:

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

Returns:

the number of elements that pass the filter

isActive

@Code("acti")
@Kind("property")
@Name("active")
@Type("boolean")
boolean isActive()

Is the service active?

Returns:

property value

getCurrentConfiguration

@Code("cnfg")
@Kind("property")
@Name("current configuration")
@Type("configuration")
Configuration getCurrentConfiguration()

The currently selected configuration.

Returns:

property value

setCurrentConfiguration

@Code("cnfg")
@Kind("property")
@Name("current configuration")
@Type("configuration")
void setCurrentConfiguration(Configuration currentConfiguration)

The currently selected configuration.

Parameters:

currentConfiguration - new property value

getId

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

The unique identifier for the service.

Returns:

property value

getInterface

@Code("intf")
@Kind("property")
@Name("interface")
@Type("interface")
Interface getInterface()

The interface the service is built on.

Returns:

property value

getKind

@Code("kind")
@Kind("property")
@Name("kind")
@Type("integer")
int getKind()

The type of service.

Returns:

property value

getName

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

The name of the service.

Returns:

property value

setName

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

The name of the service.

Parameters:

name - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties