|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
java.lang.String getId()
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.
java.lang.String getName()
java.lang.String getOid()
void setName(java.lang.String localizedRoleName)
localizedRoleName
- The localized string representation of the role.java.lang.String getRelAppName()
void setRelAppName(java.lang.String reliantApp)
reliantApp
- The reliant application for which the role is being defined.void setMutableStatus(boolean isMutable)
isMutable
- The value true
if the role is mutable, false
otherwise.boolean isMutable()
true
if the role is mutable, false
otherwise.java.lang.String getDescription()
void setDescription(java.lang.String desc)
desc
- A string value that represents the description of the role.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |