wt.notify
Interface DistributionList

All Known Implementing Classes:

WTDistributionList

public interface DistributionList

Holds users, principals, and roles and resolves these entities to a unique set of users.

Supported API: false

Extendable: false

Method Summary

void	addPrincipal(WTPrincipal principal) Adds a principal to the list.
void	addPrincipal(WTPrincipalReference principal_ref) Adds a principal to the list.
void	addRecipient(Object object) Add a recipient to the distribution list.
void	addRole(Role role) Specifies which roles in the distribution list's roleholders should be resolved to users.
void	addRoleHolder(RoleHolder2 roleHolder2) Supported API: false
void	addUser(WTUser user) Add the given user to the list of WTUsers, and add that user's locale to the list of Locales.
Enumeration	getResolvedUsers() Derives the unique set of WTUsers based on the users, principals, and roles in the distribution list.
Enumeration	getUserLocales() Returns the union of locales used by all the users in the distribution list.
Enumeration	getUsersFromLocale(Locale locale) Returns an enumeration of users from a specified locale.

Method Detail

addPrincipal

public void addPrincipal(WTPrincipal principal)
                  throws WTException

Adds a principal to the list. If principal already in the list, action is ignored.

Supported API: false

Parameters:

principal - the WTPrincipal object to be added to the rolePrincipalMap

Throws:

WTException

addPrincipal

public void addPrincipal(WTPrincipalReference principal_ref)

Adds a principal to the list. If principal already in the list, action is ignored.

Supported API: false

Parameters:

principal_ref -

addUser

public void addUser(WTUser user)
             throws WTException

Add the given user to the list of WTUsers, and add that user's locale to the list of Locales.

Supported API: false

Parameters:

user -

Throws:

WTException

addRecipient

public void addRecipient(Object object)
                  throws WTException

Add a recipient to the distribution list. The recipient can be one of:

• a user
• a group
• a team
• a WTPrincipalReference
• a TeamReference

Supported API: false

Parameters:

object -

Throws:

WTException

getResolvedUsers

public Enumeration getResolvedUsers()
                             throws WTException

Derives the unique set of WTUsers based on the users, principals, and roles in the distribution list.

Supported API: false

Returns:

Enumeration

Throws:

WTException

getUserLocales

public Enumeration getUserLocales()
                           throws WTException

Returns the union of locales used by all the users in the distribution list.

Supported API: false

Returns:

Enumeration

Throws:

WTException

getUsersFromLocale

public Enumeration getUsersFromLocale(Locale locale)
                               throws WTException

Returns an enumeration of users from a specified locale. If locale is null, returns users from the default locale.

Supported API: false

Parameters:

locale -

Returns:

Enumeration

Throws:

WTException

addRole

public void addRole(Role role)
             throws WTException

Specifies which roles in the distribution list's roleholders should be resolved to users.

Supported API: false

Parameters:

role -

Throws:

WTException

addRoleHolder

public void addRoleHolder(RoleHolder2 roleHolder2)
                   throws WTException

Supported API: false

Parameters:

roleHolder2 -

Throws:

WTException