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

public interface Role

This interface represents a role.

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.

Returns:

The role identifier.

getName

java.lang.String getName()

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

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 - true if the role is mutable, false otherwise.

isMutable

boolean isMutable()

Determines whether the role is mutable.

Returns:

true if the role is mutable, false otherwise.

getDescription

java.lang.String getDescription()

Retrieves the description of the role.

Returns:

The description of the role.

setDescription

void setDescription(java.lang.String desc)

Sets the description of the role.

Parameters:

desc - The description of the role.