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

All Superinterfaces:

java.util.Collection, ISDKSet, java.lang.Iterable, java.util.Set

public interface IUserGroupAliases
extends ISDKSet

A user group alias is another name for a group--one that never changes, even if the group name does. When you create a new Enterprise group, or map a third-party group to the system, a user group alias is automatically added to the group's UserGroupAliases collection. In general, all aliases must be unique meaning that no two objects may have the same alias. As a result, every user or group may only have one Enterprise alias, but may have several unique third-party aliases.

When a third-party group is mapped to the system, its alias name will be used by the CMS to query for the actual third-party alias ID and alias name. These values will be retrieved by the CMS and written to the group InfoObject. In order for the third-party alias information to be set, the group object needs to first be committed to the CMS. Simply adding the third-party alias name to the alias collection of the group object will not result in the proper values being set.

Re-assignment of third-party group aliases is not supported by the SAP BusinessObjects Enterprise Java Development Kit. Only re-assignment of third-party user aliases is supported.

See Also:

com.crystaldecisions.sdk.plugin.authentication.ldap

Method Summary

IUserGroupAlias	add(java.lang.String aliasName, boolean disabled) Deprecated. This method has been deprecated. Customers should use IUserGroupAliases.addNew(java.lang.String, boolean) instead.
IUserGroupAlias	addExisting(java.lang.String aliasName, java.lang.String aliasId, boolean disabled) Adds a new user group alias to the collection.
IUserGroupAlias	addNew(java.lang.String aliasName, boolean disabled) Adds a new user group alias to the collection.

Methods inherited from interface com.crystaldecisions.sdk.properties.ISDKSet

get

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

add

@Deprecated
IUserGroupAlias add(java.lang.String aliasName,
                               boolean disabled)

Deprecated. This method has been deprecated. Customers should use IUserGroupAliases.addNew(java.lang.String, boolean) instead.

Adds a new user group alias to the collection.

Parameters:

aliasName - A String containing the name of the user group alias to be added. The expected format is <auth provider>:<group name>. For example, secLDAP:Administrators.

disabled - true if the alias will be disabled, and false otherwise. It is enabled by default.

Returns:

An IUserGroupAlias object containing the newly created user group alias. Note, the returned IUserGroupAlias is not the final alias created by the CMS, but a temporary alias created by the SDK using temporary values. This information will be updated after being committed to the CMS.

addNew

IUserGroupAlias addNew(java.lang.String aliasName,
                       boolean disabled)

Adds a new user group alias to the collection.

Parameters:

aliasName - The name of the new alias, a non-null, non-empty String.

disabled - true if the new alias should be disabled, false otherwise.

Returns:

An IUserGroupAlias object containing the newly created alias.

Throws:

java.lang.NullPointerException - If the aliasName is null

java.lang.IllegalArgumentException - If the aliasName is an empty string.

addExisting

IUserGroupAlias addExisting(java.lang.String aliasName,
                            java.lang.String aliasId,
                            boolean disabled)

Adds a new user group alias to the collection.

Parameters:

aliasName - The name of the existing alias, a non-null, non-empty String.

aliasId - The ID of the existing alias with the format <auth_type>:<id>. For example, secEnterprise:#12.

disabled - true if the existing alias should be disabled, false otherwise.

Returns:

An IUserGroupAlias object containing the existing alias.

Throws:

java.lang.NullPointerException - If the aliasName or aliasId is null

java.lang.IllegalArgumentException - If the aliasName is an empty string or the aliasId is not compliant with the correct format.