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.

Field Summary

static java.lang.String	KIND The Kind used to query for UserGroup objects.
static java.lang.String	PROGID The ProgID for the UserGroup Class.

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.lang.String	getProfileString(java.lang.String name) Gets a string value from the usergroup's profile, given a specified name.
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.
void	removeProfileString(java.lang.String name) Removes a string from the usergroup's profile.
void	setProfileString(java.lang.String name, java.lang.String newProfileString) Adds a string to the usergroup's profile.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for UserGroup objects.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the UserGroup Class.

ProgID	CrystalEnterprise.UserGroup
Query Category	CI_SYSTEMOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.desktop.usergroup.IUserGroup

Query syntax:

SELECT
	SI_DESCRIPTION, SI_NAME, SI_ID
FROM
	CI_SYSTEMOBJECTS
WHERE
	SI_PROGID='CrystalEnterprise.UserGroup'

The IUserGroup interface does not contain any methods or properties that require specific CePropertyIDs to be referenced in the SELECT Statement. However, you can access general InfoObject properties, such as the SI_NAME, SI_DESCRIPTION, and SI_ID from the objects returned by the query.

See Also:

Constant Field Values

Method Detail

getSubGroups

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.

InfoObject properties to query for:

SI_SUBGROUPS

getUsers

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.

InfoObject properties to query for:

SI_GROUP_MEMBERS

getParentGroups

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.

InfoObject properties to query for:

SI_USERGROUPS

getAliases

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.

InfoObject properties to query for:

SI_ALIASES

getProfileString

java.lang.String getProfileString(java.lang.String name)
                                  throws SDKException

Gets a string value from the usergroup's profile, given a specified name.

Parameters:

name - The name of the string to be returned.

Returns:

A String containing the requested string value from the usergroup's profile.

Throws:

SDKException - if the corresponding property is not found.

InfoObject properties to query for:

SI_DATA

setProfileString

void setProfileString(java.lang.String name,
                      java.lang.String newProfileString)

Adds a string to the usergroup's profile.

Parameters:

name - The name of the string to be added.

newProfileString - A String containing the value of the string to be added to the usergroup's profile.

InfoObject properties to query for:

SI_DATA

removeProfileString

void removeProfileString(java.lang.String name)
                         throws SDKException

Removes a string from the usergroup's profile.

Parameters:

name - The name of the string to be removed.

Throws:

SDKException - if the corresponding property is not found.

InfoObject properties to query for:

SI_DATA