com.crystaldecisions.sdk.plugin.desktop.usergroup
Interface IUserGroupBase

All Known Subinterfaces:

IUserGroup

public interface IUserGroupBase

The IUserGroupBase interface stores information about a group and manages its group associates (users, parent groups, and subgroups). It is the top level object in the UserGroup plugin.

Use this object to create new groups and add their group associates; use the UserGroupAliases collection's add method to add third-party group members to an existing group. When you add a new Enterprise group or map a third-party group to the system, an alias for this group is created automatically and added to the UserGroupAliases collection.

Method Summary

IUserGroupAliases	getAliases() Returns a collection of the aliases that are associated with the user groups.
java.util.Set	getParentGroups() Returns a collection of the parent groups that the group is a member of.
java.util.Set	getSubGroups() Returns a collection of the group's subgroups.
java.util.Set	getUsers() Returns a collection of the users that are members of the group.

Method Detail

getSubGroups

public java.util.Set getSubGroups()

Returns a collection of the group's subgroups.

Returns:

A Set whose elements are the Integer group IDs of the subgroups. This Set contains Integer objects containing the SI_IDs of the sub groups that belong to this group.

getUsers

public java.util.Set getUsers()

Returns a collection of the users that are members of the group.

Returns:

A Set whose elements are the Integer user IDs of the group members. This Set contains Integer objects containing the SI_IDs of the users that belong to this group.

getParentGroups

public java.util.Set getParentGroups()

Returns a collection of the parent groups that the group is a member of.

Returns:

A Set whose elements are the Integer group IDs of the parent groups. This Set contains Integer objects containing the SI_IDs of this group's parent groups.

getAliases

public IUserGroupAliases getAliases()

Returns a collection of the aliases that are associated with the user groups.

Returns:

An IUserGroupAliases object containing a collection of the aliases that are associated with the user groups.