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

public interface IUserGroupAlias

An IUserGroupAlias interface is created automatically when a group is added to the system. A user group alias is an alternative name that is assigned to a group. The group may be a native Enterprise group, or it may be a third-party group.

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. Note, this function will throw an exception when called on a newly created alias that has not been successfully committed to the CMS. This method will only return a proper value after querying for the newly committed IUserGroup object.

Returns:

A String containing the ID for the alias.

getName

java.lang.String getName()

Returns the name of the alias. Note, when this method is called on a newly created alias before it has been committed, the alias name as specified by the IUserGroupAliases add method will be returned. After being committed, the alias name specified by the 3rd Party authentication provider will be returned.

Returns:

A String the name of the alias.

getAuthentication

java.lang.String getAuthentication()

Returns the authentication that the alias is associated with. Note, this function will throw an exception when called on a newly created alias that has not been successfully committed to the CMS. This method will only return a proper value after querying for the newly committed IUserGroup object.

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 "INFO" or "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.