com.crystaldecisions.sdk.plugin.desktop.user
Interface IUserAlias

public interface 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. An alias, which is an alternative name that is assigned to a user, allows the user to log on to the Enterprise system using different names and authentication types. A user can have multiple aliases, each of which can be re-assigned to another user with the IUserAliases interface.

Field Summary

static int	ENTERPRISE This constant specifies that the authentication provider will be a native Enterprise alias.
static int	THIRD_PARTY This constant specifies that the authentication provider will be an alias from a third-party authentication provider.

Method Summary

java.lang.String	getAuthentication() Returns the authentication that the alias is associated with.
java.lang.String	getID() Returns the ID for the alias.
java.lang.String	getName() Returns the name of the alias.
int	getType() Returns the authentication provider for the alias.
boolean	isDisabled() Returns whether the alias is disabled.
void	setDisabled(boolean newDisabled) Disables the alias.

Field Detail

ENTERPRISE

static final int ENTERPRISE

This constant specifies that the authentication provider will be a native Enterprise alias.

See Also:

Constant Field Values

THIRD_PARTY

static final int THIRD_PARTY

This constant specifies that the authentication provider will be an alias from a third-party authentication provider.

See Also:

Constant Field Values

Method Detail

getID

java.lang.String getID()

Returns the ID for the alias. However, in order to retrieve the true ID of the object that the alias is associated with, you must concatenate the getAuthentication() method, together with a colon, to the getID() method.
For example:
IUserAliasObject.getAuthentication()+ ":" + IUserAliasObject.getID().

Returns:

A String containing the ID for the alias.

getName

java.lang.String getName()

Returns the name of the alias.

Returns:

A String containing the name of the alias.

getAuthentication

java.lang.String getAuthentication()

Returns the authentication that the alias is associated with.

Returns:

A String containing the authentication that the alias is associated with.

getType

int getType()

Returns the authentication provider for the alias.

Returns:

An int containing the authentication provider for the alias. This value should be one of the constants IUserAlias.ENTERPRISE or IUserAlias.THIRD_PARTY.

isDisabled

boolean isDisabled()

Returns whether the alias is disabled.

Returns:

true if the alias is disabled, false otherwise.

setDisabled

void setDisabled(boolean newDisabled)

Disables the alias.

Parameters:

newDisabled - true if the alias is disabled, false otherwise.