Package com.crystaldecisions.sdk.plugin.desktop.user

This package provides an interface through which an administrator can set the specific behavior of each user in the Enterprise system.

See:
Description

Interface Summary

IUser	The IUser interface is used to determine the specific behavior of each user.
IUserAlias	An IUserAlias interface is created automatically when a user is created, or when a member of a third-party group is mapped to the system.
IUserAliases	This interface defines a collection of IUserAlias objects.
IUserBase	The IUserBase interface is used to determine the specific behavior of each user.

Package com.crystaldecisions.sdk.plugin.desktop.user Description

This package provides an interface through which an administrator can set the specific behavior of each user in the Enterprise system. For example, it can be used to change a user's password or specify the groups that a user belongs to.

The User plugin also allows you to manage user aliases. An alias is an alternative name that is automatically generated when a new Enterprise user is created or when a member of a third-party group is mapped to the system. A user can log on to the Enterprise system using the user name and password of any alias that exists in the UserAliases Collection.

Note: The User plugin allows you to add new users and to determine their group membership, whereas the UserGroup plugin allows you to add new groups and determine the users that belong to these groups. The user's group list and the group's user list are synchronized.

The diagram below illustrates the object model that is implemented by the User plugin:

Retrieving desktop plugins

Each object that is created with a desktop plugin is stored in either the CI_INFOOBJECTS or the CI_SYSTEMOBJECTS category in the CMS InfoStore, and is marked with a programmatic identifier (SI_KIND). Using SI_KIND, you can query the CMS InfoStore for a collection of objects.

Example

The following query selects the names and IDs of all User objects in the CMS:

IInfoObjects userObjs = iStore.query("SELECT SI_NAME, SI_ID FROM CI_SYSTEMOBJECTS Where SI_KIND='User');

The query method returns a collection of InfoObjects, which in this case are IUser objects. Like other InfoObjects, these objects are uniquely represented by their ID property. For each object in the collection, you can access general InfoObject properties, such as the SI_NAME property, SI_DESCRIPTION property, and SI_ID property.

To access the IUser objects returned by the query, the resulting IInfoObjects need to be cast. This example demonstrates how to cast the returned IInfoObjects as IUser objects.

for (int i = 0; i < userObjs.size(); i++)
{
    IInfoObject obj = (IInfoObject) userObjs.get(i);
    IUser user = (IUser) obj;
}

Related Documentation

• Object Model Diagram