com.hcl.domino.admin

Interface Group

All Known Implementing Classes:

AbstractGroup, GroupAuto, GroupManual

public interface Group

Interface for Groups in the Domino Directory and Personal Address Book

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Group.GroupType

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAdministrators()
java.lang.String	getCategory()
java.lang.String	getDescription()
java.lang.String	getInternetAddress()
java.lang.String	getMailDomain()
java.util.TreeSet<java.lang.String>	getMembers()
java.lang.String	getMetaversalId()
java.lang.String	getName()
java.lang.String	getNoteId()
java.util.List<java.lang.String>	getOwners()
Group.GroupType	getType()
java.lang.String	getUnid()
void	loadMetadata(com.hcl.domino.data.Database db, com.hcl.domino.data.Document doc) Sets metaversalID and UNID from database and note
void	resolve(KeepJnxSession s, java.util.Map<java.lang.String,java.lang.String> groups) Iterates through groups to expand out all members to individuals’ names
void	setAdministrators(java.util.List<java.lang.String> administrators)
void	setCategory(java.lang.String category)
void	setDescription(java.lang.String description)
void	setInternetAddress(java.lang.String internetAddress)
void	setMailDomain(java.lang.String mailDomain)
void	setName(java.lang.String name)
void	setOwners(java.util.List<java.lang.String> owners)
void	setType(Group.GroupType type)
void	writeToNote(com.hcl.domino.data.Document note) Serializes values from Group to a specific Document

Method Detail

getAdministrators

java.util.List<java.lang.String> getAdministrators()

Returns:

list of administrators for the group. This can include named users or groups. This is only used for access if the users are restricted to Author access in the directory’s ACL.

getCategory

java.lang.String getCategory()

Returns:

category used for grouping groups in the Notes Client

getDescription

java.lang.String getDescription()

Returns:

textual description for the group

getInternetAddress

java.lang.String getInternetAddress()

Returns:

internet address, only relevant to mail groups or multi-purpose groups used for mailing

getMailDomain

java.lang.String getMailDomain()

Returns:

mail domain, only relevant to mail groups or multi-purpose groups used for mailing

getMembers

java.util.TreeSet<java.lang.String> getMembers()

Returns:

list of members - named individuals and/or groups

getMetaversalId

java.lang.String getMetaversalId()

Returns:

document NoteID + “~” + database relative path, to retrieve the document on the current server

getName

java.lang.String getName()

Returns:

group name

getNoteId

java.lang.String getNoteId()

Returns:

gets document NoteID, first part of the metaversal ID

getOwners

java.util.List<java.lang.String> getOwners()

Returns:

owners for the group. This should only include named individuals. This is only used for access if the users are restricted to Author access in the directory’s ACL.

getType

Group.GroupType getType()

Returns:

type denoting how the group can be used within Domino

getUnid

java.lang.String getUnid()

Returns:

gets document UNID

loadMetadata

void loadMetadata(com.hcl.domino.data.Database db,
                  com.hcl.domino.data.Document doc)

Sets metaversalID and UNID from database and note

Parameters:

db -

• from which to get database path for metaversal ID

doc -

• from which to get NoteID (for metaversalID) and UNID

resolve

void resolve(KeepJnxSession s,
             java.util.Map<java.lang.String,java.lang.String> groups)

Iterates through groups to expand out all members to individuals’ names

Parameters:

s - KeepJnxSession for the current user

groups - All groups in relevant directories

setAdministrators

void setAdministrators(java.util.List<java.lang.String> administrators)

Parameters:

administrators - for the group, either named individuals or other groups

setCategory

void setCategory(java.lang.String category)

Parameters:

category - used for grouping groups in the Notes Client

setDescription

void setDescription(java.lang.String description)

Parameters:

description - for the group

setInternetAddress

void setInternetAddress(java.lang.String internetAddress)

Parameters:

internetAddress - only relevant to mail groups or multi-purpose groups used for mailing

setMailDomain

void setMailDomain(java.lang.String mailDomain)

Parameters:

mailDomain - only relevant to mail groups or multi-purpose groups used for mailing

setName

void setName(java.lang.String name)

Parameters:

name - of the group

setOwners

void setOwners(java.util.List<java.lang.String> owners)

Parameters:

owners - for the group. This should only include named individuals

setType

void setType(Group.GroupType type)

Parameters:

type - denoting how the group can be used within Domino

writeToNote

void writeToNote(com.hcl.domino.data.Document note)

Serializes values from Group to a specific Document

Parameters:

note - NoteNote to which to write values