com.netegrity.llsdk6.imsapi.metadata
Interface RoleDisplayData

public interface RoleDisplayData

Represents the information Identity Manager needs to display a line in a list of roles.

This object is returned from getRoleDisplayData().

Since:

IdentityMinder 6.0

Method Summary

java.lang.String	getEnvironmentFriendlyName() Retrieves the friendly name of the Identity Manager environment that contains the current role.
java.lang.String	getEnvironmentUniqueName() Retrieves the unique name of the Identity Manager environment that contains the current role.
java.lang.String	getRoleDescription() Retrieves the description of the current role.
java.lang.String	getRoleFriendlyName() Retrieves the friendly name of the current role.
java.lang.String	getRoleUniqueName() Retrieves the unique name of the current role.
ObjectType	getType() Retrieves the type of the current role.

Method Detail

getRoleUniqueName

java.lang.String getRoleUniqueName()
                                   throws SmApiException

Retrieves the unique name of the current role.

Returns:

The unique name of this role.

Throws:

SmApiException

getRoleFriendlyName

java.lang.String getRoleFriendlyName()
                                     throws SmApiException

Retrieves the friendly name of the current role.

Returns:

The friendly name of this role.

Throws:

SmApiException

getRoleDescription

java.lang.String getRoleDescription()
                                    throws SmApiException

Retrieves the description of the current role.

Returns:

The description of this role.

Throws:

SmApiException

getEnvironmentUniqueName

java.lang.String getEnvironmentUniqueName()
                                          throws SmApiException

Retrieves the unique name of the Identity Manager environment that contains the current role.

Returns:

The unique name of the role's environment.

Throws:

SmApiException

getEnvironmentFriendlyName

java.lang.String getEnvironmentFriendlyName()
                                            throws SmApiException

Retrieves the friendly name of the Identity Manager environment that contains the current role.

Returns:

The friendly name of the role's environment.

Throws:

SmApiException

getType

ObjectType getType()
                   throws SmApiException

Retrieves the type of the current role.

Returns:

The role type.

Throws:

SmApiException