Role (Oracle® Fusion Middleware Java API Reference for Identity Governance Framework IDXUserRole)

java.lang.Object
- org.openliberty.arisidbeans.IGFObject
- - oracle.igf.idxuserrole.Role

```
public class Role
extends IGFObject
```
This Role class generated from CARML file idxuserrole.xml has get/set methods for the attributes declared in the CARML file

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMMONNAME` Common Name
`static java.lang.String`	`DESCRIPTION` Description
`static java.lang.String`	`DISPLAYNAME` Display Name
`static java.lang.String`	`GUID` Global Unique ID in repository
`static java.lang.String`	`MAIL` Email ID
`static java.lang.String`	`MEMBER` Unique Member
`static java.lang.String`	`NAME` Name
`static java.lang.String`	`ORG` Organization
`static java.lang.String`	`ORGUNIT` Organizational Unit
`static java.lang.String`	`OWNER` Owner
`static java.lang.String`	`ROLECATEGORY` Role Category
`static java.lang.String`	`SEEALSO` See Also
`static java.lang.String`	`TENANTGID` Tenant Unique ID
`static java.lang.String`	`TENANTGUID` Tenant Global Unique Id
`static java.lang.String`	`TENANTUID` Tenant Unique ID
`static java.lang.String`	`TENANTUNIQUENAME` Tenant Unique Name
`static java.lang.String`	`UNIQUENAME` Unique name of the subject
`static java.lang.String`	`VISIBLE` Is Visible (for system/app id users/groups visible value is false)

Constructor Summary

Constructors
Constructor and Description
`Role(RoleManager mgr, IDigitalSubject subj)`
`Role(RoleManager mgr, IDigitalSubject subj, java.util.Map<java.lang.String,java.util.Map<java.util.Locale,java.lang.String>> map)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`compare(Role subj)`
`java.lang.String`	`getCommonname()` Returns commonname from Role object
`java.lang.String`	`getCommonname(java.util.Locale locale)` Returns commonname from Role object for a Locale
`java.lang.String`	`getDescription()` Returns description from Role object
`java.lang.String`	`getDescription(java.util.Locale locale)` Returns description from Role object for a Locale
`java.lang.String`	`getDisplayname()` Returns displayname from Role object
`java.lang.String`	`getDisplayname(java.util.Locale locale)` Returns displayname from Role object for a Locale
`java.lang.String`	`getGuid()` Returns guid from Role object
`java.lang.String`	`getGuid(java.util.Locale locale)` Returns guid from Role object for a Locale
`java.lang.String`	`getMail()` Returns mail from Role object
`java.lang.String`	`getMail(java.util.Locale locale)` Returns mail from Role object for a Locale
`java.lang.String`	`getMember()` Returns member from Role object
`java.lang.String`	`getMember(java.util.Locale locale)` Returns member from Role object for a Locale
`java.lang.String`	`getName()` Returns name from Role object
`java.lang.String`	`getName(java.util.Locale locale)` Returns name from Role object for a Locale
`java.lang.String`	`getOrg()` Returns org from Role object
`java.lang.String`	`getOrg(java.util.Locale locale)` Returns org from Role object for a Locale
`java.lang.String`	`getOrgunit()` Returns orgunit from Role object
`java.lang.String`	`getOrgunit(java.util.Locale locale)` Returns orgunit from Role object for a Locale
`java.lang.String`	`getOwner()` Returns owner from Role object
`java.lang.String`	`getOwner(java.util.Locale locale)` Returns owner from Role object for a Locale
`java.lang.String`	`getRolecategory()` Returns rolecategory from Role object
`java.lang.String`	`getRolecategory(java.util.Locale locale)` Returns rolecategory from Role object for a Locale
`java.lang.String`	`getSeealso()` Returns seealso from Role object
`java.lang.String`	`getSeealso(java.util.Locale locale)` Returns seealso from Role object for a Locale
`java.lang.String`	`getTenantgid()` Returns tenantgid from Role object
`java.lang.String`	`getTenantgid(java.util.Locale locale)` Returns tenantgid from Role object for a Locale
`java.lang.String`	`getTenantguid()` Returns tenantguid from Role object
`java.lang.String`	`getTenantguid(java.util.Locale locale)` Returns tenantguid from Role object for a Locale
`java.lang.String`	`getTenantuid()` Returns tenantuid from Role object
`java.lang.String`	`getTenantuid(java.util.Locale locale)` Returns tenantuid from Role object for a Locale
`java.lang.String`	`getTenantuniquename()` Returns tenantuniquename from Role object
`java.lang.String`	`getTenantuniquename(java.util.Locale locale)` Returns tenantuniquename from Role object for a Locale
`java.lang.String`	`getUniquename()` Returns uniquename from Role object
`java.lang.String`	`getUniquename(java.util.Locale locale)` Returns uniquename from Role object for a Locale
`java.lang.String`	`getVisible()` Returns visible from Role object
`java.lang.String`	`getVisible(java.util.Locale locale)` Returns visible from Role object for a Locale

Methods inherited from class org.openliberty.arisidbeans.IGFObject
getAllAttributes, getAllPredicates, getAllProperties, getAllRoles, getAttribute, getAttributeLocaleValue, getAttributeLocaleValue, getAttributes, getAttributeValue, getError, getPredicate, getPredicates, getPredicateValue, getPrincipalIdentifier, getProperties, getProperty, getPropertyValue, getRole, getRoles, getSubjectName, hasRole, isError, isPredicateTrue, setAttribute, setAttribute, setAttribute, setAttributes, setAttributes, setAttributes, setAttributeValue, setAttributeValue

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COMMONNAME
```
public static final java.lang.String COMMONNAME
```
    Common Name
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final java.lang.String DESCRIPTION
```
    Description
    
    See Also:
    
    Constant Field Values
  - DISPLAYNAME
```
public static final java.lang.String DISPLAYNAME
```
    Display Name
    
    See Also:
    
    Constant Field Values
  - GUID
```
public static final java.lang.String GUID
```
    Global Unique ID in repository
    
    See Also:
    
    Constant Field Values
  - MAIL
```
public static final java.lang.String MAIL
```
    Email ID
    
    See Also:
    
    Constant Field Values
  - MEMBER
```
public static final java.lang.String MEMBER
```
    Unique Member
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    Name
    
    See Also:
    
    Constant Field Values
  - ORG
```
public static final java.lang.String ORG
```
    Organization
    
    See Also:
    
    Constant Field Values
  - ORGUNIT
```
public static final java.lang.String ORGUNIT
```
    Organizational Unit
    
    See Also:
    
    Constant Field Values
  - OWNER
```
public static final java.lang.String OWNER
```
    Owner
    
    See Also:
    
    Constant Field Values
  - ROLECATEGORY
```
public static final java.lang.String ROLECATEGORY
```
    Role Category
    
    See Also:
    
    Constant Field Values
  - SEEALSO
```
public static final java.lang.String SEEALSO
```
    See Also
    
    See Also:
    
    Constant Field Values
  - TENANTGID
```
public static final java.lang.String TENANTGID
```
    Tenant Unique ID
    
    See Also:
    
    Constant Field Values
  - TENANTGUID
```
public static final java.lang.String TENANTGUID
```
    Tenant Global Unique Id
    
    See Also:
    
    Constant Field Values
  - TENANTUID
```
public static final java.lang.String TENANTUID
```
    Tenant Unique ID
    
    See Also:
    
    Constant Field Values
  - TENANTUNIQUENAME
```
public static final java.lang.String TENANTUNIQUENAME
```
    Tenant Unique Name
    
    See Also:
    
    Constant Field Values
  - UNIQUENAME
```
public static final java.lang.String UNIQUENAME
```
    Unique name of the subject
    
    See Also:
    
    Constant Field Values
  - VISIBLE
```
public static final java.lang.String VISIBLE
```
    Is Visible (for system/app id users/groups visible value is false)
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Role
```
public Role(RoleManager mgr,
            IDigitalSubject subj)
```
  - Role
```
public Role(RoleManager mgr,
            IDigitalSubject subj,
            java.util.Map<java.lang.String,java.util.Map<java.util.Locale,java.lang.String>> map)
```
- Method Detail
  - compare
```
public boolean compare(Role subj)
```
  - getCommonname
```
public java.lang.String getCommonname()
```
    Returns commonname from Role object
  - getCommonname
```
public java.lang.String getCommonname(java.util.Locale locale)
```
    Returns commonname from Role object for a Locale
  - getDescription
```
public java.lang.String getDescription()
```
    Returns description from Role object
  - getDescription
```
public java.lang.String getDescription(java.util.Locale locale)
```
    Returns description from Role object for a Locale
  - getDisplayname
```
public java.lang.String getDisplayname()
```
    Returns displayname from Role object
  - getDisplayname
```
public java.lang.String getDisplayname(java.util.Locale locale)
```
    Returns displayname from Role object for a Locale
  - getGuid
```
public java.lang.String getGuid()
```
    Returns guid from Role object
  - getGuid
```
public java.lang.String getGuid(java.util.Locale locale)
```
    Returns guid from Role object for a Locale
  - getMail
```
public java.lang.String getMail()
```
    Returns mail from Role object
  - getMail
```
public java.lang.String getMail(java.util.Locale locale)
```
    Returns mail from Role object for a Locale
  - getMember
```
public java.lang.String getMember()
```
    Returns member from Role object
  - getMember
```
public java.lang.String getMember(java.util.Locale locale)
```
    Returns member from Role object for a Locale
  - getName
```
public java.lang.String getName()
```
    Returns name from Role object
  - getName
```
public java.lang.String getName(java.util.Locale locale)
```
    Returns name from Role object for a Locale
  - getOrg
```
public java.lang.String getOrg()
```
    Returns org from Role object
  - getOrg
```
public java.lang.String getOrg(java.util.Locale locale)
```
    Returns org from Role object for a Locale
  - getOrgunit
```
public java.lang.String getOrgunit()
```
    Returns orgunit from Role object
  - getOrgunit
```
public java.lang.String getOrgunit(java.util.Locale locale)
```
    Returns orgunit from Role object for a Locale
  - getOwner
```
public java.lang.String getOwner()
```
    Returns owner from Role object
  - getOwner
```
public java.lang.String getOwner(java.util.Locale locale)
```
    Returns owner from Role object for a Locale
  - getRolecategory
```
public java.lang.String getRolecategory()
```
    Returns rolecategory from Role object
  - getRolecategory
```
public java.lang.String getRolecategory(java.util.Locale locale)
```
    Returns rolecategory from Role object for a Locale
  - getSeealso
```
public java.lang.String getSeealso()
```
    Returns seealso from Role object
  - getSeealso
```
public java.lang.String getSeealso(java.util.Locale locale)
```
    Returns seealso from Role object for a Locale
  - getTenantgid
```
public java.lang.String getTenantgid()
```
    Returns tenantgid from Role object
  - getTenantgid
```
public java.lang.String getTenantgid(java.util.Locale locale)
```
    Returns tenantgid from Role object for a Locale
  - getTenantguid
```
public java.lang.String getTenantguid()
```
    Returns tenantguid from Role object
  - getTenantguid
```
public java.lang.String getTenantguid(java.util.Locale locale)
```
    Returns tenantguid from Role object for a Locale
  - getTenantuid
```
public java.lang.String getTenantuid()
```
    Returns tenantuid from Role object
  - getTenantuid
```
public java.lang.String getTenantuid(java.util.Locale locale)
```
    Returns tenantuid from Role object for a Locale
  - getTenantuniquename
```
public java.lang.String getTenantuniquename()
```
    Returns tenantuniquename from Role object
  - getTenantuniquename
```
public java.lang.String getTenantuniquename(java.util.Locale locale)
```
    Returns tenantuniquename from Role object for a Locale
  - getUniquename
```
public java.lang.String getUniquename()
```
    Returns uniquename from Role object
  - getUniquename
```
public java.lang.String getUniquename(java.util.Locale locale)
```
    Returns uniquename from Role object for a Locale
  - getVisible
```
public java.lang.String getVisible()
```
    Returns visible from Role object
  - getVisible
```
public java.lang.String getVisible(java.util.Locale locale)
```
    Returns visible from Role object for a Locale

Class Role

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.openliberty.arisidbeans.IGFObject

Methods inherited from class java.lang.Object

Field Detail

COMMONNAME

DESCRIPTION

DISPLAYNAME

GUID

MAIL

MEMBER

NAME

ORG

ORGUNIT

OWNER

ROLECATEGORY

SEEALSO

TENANTGID

TENANTGUID

TENANTUID

TENANTUNIQUENAME

UNIQUENAME

VISIBLE

Constructor Detail

Role

Role

Method Detail

compare

getCommonname

getCommonname

getDescription

getDescription

getDisplayname

getDisplayname

getGuid

getGuid

getMail

getMail

getMember

getMember

getName

getName

getOrg

getOrg

getOrgunit

getOrgunit

getOwner

getOwner

getRolecategory

getRolecategory

getSeealso

getSeealso

getTenantgid

getTenantgid

getTenantguid

getTenantguid

getTenantuid

getTenantuid

getTenantuniquename

getTenantuniquename

getUniquename

getUniquename

getVisible

getVisible