com.adobe.idp.um.api.infomodel
Interface Role

public interface Role

The Role interface represents a role that can be assigned to a principal. For example, using a Role instance, you can assign a role, such as a Service User, to a LiveCycle ES2 user. The Service User role lets a user invoke LiveCycle ES2 services. To see an object of this type used in a code example, see the Managing roles and permissions using the Java API quick start in Programming with LiveCycle ES4.

Method Summary

java.lang.String	getDescription() Retrieves the description of the role.
java.lang.String	getId() Retrieves the role identifier, which is the internal String representation of the role.
java.lang.String	getName() Retrieves a localized string representation of the role.
java.lang.String	getOid() Retrieves the role identifier, which is the internal string representation of the role.
java.lang.String	getRelAppName() Retrieves the reliant application for which the role is being defined.
boolean	isMutable() Determines whether the role is mutable.
void	setDescription(java.lang.String desc) Sets the description of the role.
void	setMutableStatus(boolean isMutable) Sets whether the role is mutable.
void	setName(java.lang.String localizedRoleName) Sets the localized string representation of the role.
void	setRelAppName(java.lang.String reliantApp) Sets the reliant application for which the role is being defined.

Method Detail

getId

java.lang.String getId()

Retrieves the role identifier, which is the internal String representation of the role. For example, Service User. To see this method used in a code example, see the Managing roles and permissions using the Java API quick start in Programming with LiveCycle ES4.

Returns:

A string value that specifies the role identifier.

getName

java.lang.String getName()

Retrieves a localized string representation of the role. This can be used for display in a user interface of a client application.

Returns:

A localized string representation of the role.

getOid

java.lang.String getOid()

Retrieves the role identifier, which is the internal string representation of the role.

Returns:

A string representation of the role.

setName

void setName(java.lang.String localizedRoleName)

Sets the localized string representation of the role. This can be used for display in the user interface.

Parameters:

localizedRoleName - The localized string representation of the role.

getRelAppName

java.lang.String getRelAppName()

Retrieves the reliant application for which the role is being defined.

Returns:

The reliant application for which the role is being defined.

setRelAppName

void setRelAppName(java.lang.String reliantApp)

Sets the reliant application for which the role is being defined.

Parameters:

reliantApp - The reliant application for which the role is being defined.

setMutableStatus

void setMutableStatus(boolean isMutable)

Sets whether the role is mutable. If this setter is not called the role is created as immutable by default. This case is same as calling setMutableStatus(false)

Parameters:

isMutable - The value true if the role is mutable, false otherwise.

isMutable

boolean isMutable()

Determines whether the role is mutable.

Returns:

The value true if the role is mutable, false otherwise.

getDescription

java.lang.String getDescription()

Retrieves the description of the role.

Returns:

A string value that represents the description of the role.

setDescription

void setDescription(java.lang.String desc)

Sets the description of the role.

Parameters:

desc - A string value that represents the description of the role.