Packagecom.adobe.idp.um.api.infomodel
Interfacepublic interface Role

This interface represents a role.


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

Retrieves the description of the role.

Returns
The description of the role.
getId() 
public String getId()

Retrieves the role identifier, which is the internal String representation of the Role.

Returns
The role identifier.

Example
How to use examples
"BASIC_ROLE_ADMIN"
getName() 
public 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() 
public String getOid()

Retrieves the role identifier, which is the internal String representation of the Role.

Returns
A string representation of the role.
getRelAppName() 
public String getRelAppName()

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

Returns
The reliant application for which the role is being defined.
isMutable() 
public boolean isMutable()

Determines whether the role is mutable.

Returns
true if the role is mutable, false otherwise.
setDescription() 
public void setDescription(String desc)

Sets the description of the role.

Parameters

desc — The description of the role.

setMutableStatus() 
public 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.

setName() 
public void setName(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.

setRelAppName() 
public void setRelAppName(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.




© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Wed Oct 1 2008, 10:46 PM -04:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/um/api/infomodel/Role.html