Module tagtraum.japlcontact

Package com.tagtraum.macos.contacts

Interface Group

All Superinterfaces:

Entry, Reference

@Plural("groups")
@Code("azf5")
@Name("group")
@Inherits("entry")
public interface Group
extends Reference, Entry

A Group Record in the address book database.

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	countGroups()
int	countGroups(String filter)
default int	countPersons()
int	countPersons(String filter)
Group	getGroup(int index)
Group	getGroup(Id id)
default Group[]	getGroups()
Group[]	getGroups(String filter)
String	getName()	The name of this group.
Person	getPerson(int index)
Person	getPerson(Id id)
default Person[]	getPersons()
Person[]	getPersons(String filter)
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
void	setName(String name)	The name of this group.

Methods inherited from interface com.tagtraum.macos.contacts.Entry

getCreationDate, getId, getModificationDate, isSelected, setSelected

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getGroups

@Kind("element")
@Type("group")
default Group[] getGroups()

Returns:

an array of all Groups

getGroups

@Kind("element")
@Type("group")
Group[] getGroups(String filter)

Parameters:

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

Returns:

an array of all Groups

getGroup

@Kind("element")
@Type("group")
Group getGroup(int index)

Parameters:

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

Returns:

the Group at the requested index

getGroup

@Kind("element")
@Type("group")
Group getGroup(Id id)

Parameters:

id - id of the item

Returns:

the Group with the requested id

countGroups

@Kind("element")
@Type("group")
default int countGroups()

Returns:

number of all Groups

countGroups

@Kind("element")
@Type("group")
int countGroups(String filter)

Parameters:

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

Returns:

the number of elements that pass the filter

getPersons

@Kind("element")
@Type("person")
default Person[] getPersons()

Returns:

an array of all Persons

getPersons

@Kind("element")
@Type("person")
Person[] getPersons(String filter)

Parameters:

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

Returns:

an array of all Persons

getPerson

@Kind("element")
@Type("person")
Person getPerson(int index)

Parameters:

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

Returns:

the Person at the requested index

getPerson

@Kind("element")
@Type("person")
Person getPerson(Id id)

Parameters:

id - id of the item

Returns:

the Person with the requested id

countPersons

@Kind("element")
@Type("person")
default int countPersons()

Returns:

number of all Persons

countPersons

@Kind("element")
@Type("person")
int countPersons(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 this group.

Returns:

property value

setName

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

The name of this group.

Parameters:

name - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Specified by:

getProperties in interface Entry

Returns:

Map containing all properties