java.lang.Object
- org.openbravo.base.structure.BaseOBObject
- - org.openbravo.model.ad.access.Role

All Implemented Interfaces:

Serializable, BaseOBObjectDef, OBNotSingleton, OBProvidable, ActiveEnabled, ClientEnabled, DynamicEnabled, Identifiable, OrganizationEnabled, Traceable
```
public class Role
extends BaseOBObject
implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled
```
Entity class for entity ADRole (stored in table AD_Role).
Help: Define the role and add the client and organizations the role has access to. You can give users access to this role and modify the access of this role to windows, forms, processes and reports as well as tasks. <BR>If the Role User Level is Manual, the as Select Role for with Data Access Restrictions
NOTE: This class should not be instantiated directly. To instantiate this class the OBProvider should be used.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ENTITY_NAME`
`static String`	`PROPERTY_ACTIVE`	Property active stored in column IsActive in table AD_Role
`static String`	`PROPERTY_ADALERTRECIPIENTLIST`	Property aDAlertRecipientList stored in table AD_Role
`static String`	`PROPERTY_ADFORMACCESSLIST`	Property aDFormAccessList stored in table AD_Role
`static String`	`PROPERTY_ADPREFERENCEVISIBLEATROLELIST`	Property aDPreferenceVisibleAtRoleList stored in table AD_Role
`static String`	`PROPERTY_ADPROCESSACCESSLIST`	Property aDProcessAccessList stored in table AD_Role
`static String`	`PROPERTY_ADROLEINHERITANCEINHERITFROMLIST`	Property aDRoleInheritanceInheritFromList stored in table AD_Role
`static String`	`PROPERTY_ADROLEINHERITANCELIST`	Property aDRoleInheritanceList stored in table AD_Role
`static String`	`PROPERTY_ADROLEORGANIZATIONLIST`	Property aDRoleOrganizationList stored in table AD_Role
`static String`	`PROPERTY_ADTABLEACCESSLIST`	Property aDTableAccessList stored in table AD_Role
`static String`	`PROPERTY_ADUSERROLESLIST`	Property aDUserRolesList stored in table AD_Role
`static String`	`PROPERTY_ADVANCED`	Property advanced stored in column IsAdvanced in table AD_Role Help: Automatic (non manual) advanced roles are granted with features checked as advanced.
`static String`	`PROPERTY_ADWINDOWACCESSLIST`	Property aDWindowAccessList stored in table AD_Role
`static String`	`PROPERTY_APPROVALAMOUNT`	Property approvalAmount stored in column AmtApproval in table AD_Role Help: The Approval Amount field indicates the amount limit this Role has for approval of documents.
`static String`	`PROPERTY_CLIENT`	Property client stored in column AD_Client_ID in table AD_Role
`static String`	`PROPERTY_CLIENTADMIN`	Property clientAdmin stored in column IS_Client_Admin in table AD_Role Help: Defines the role as an administrator of the client it belongs to.
`static String`	`PROPERTY_CREATEDBY`	Property createdBy stored in column CreatedBy in table AD_Role
`static String`	`PROPERTY_CREATIONDATE`	Property creationDate stored in column Created in table AD_Role
`static String`	`PROPERTY_CURRENCY`	Property currency stored in column C_Currency_ID in table AD_Role Help: Indicates the currency to be used when processing this document.
`static String`	`PROPERTY_DESCRIPTION`	Property description stored in column Description in table AD_Role Help: A description is limited to 255 characters.
`static String`	`PROPERTY_FORPORTALUSERS`	Property forPortalUsers stored in column IsPortal in table AD_Role Help: If checked, this role will have a simplified (portal) interface, where it only has available the workspace widgets.
`static String`	`PROPERTY_ID`	Property id stored in column AD_Role_ID in table AD_Role Help: The Role determines security and access a user who has this Role will have in the System.
`static String`	`PROPERTY_ISRESTRICTBACKEND`	Property isrestrictbackend stored in column Isrestrictbackend in table AD_Role Help: If checked, this role will not have access to the backend. It will however have access to other applications (such as the WebPOS)
`static String`	`PROPERTY_ISWEBSERVICEENABLED`	Property isWebServiceEnabled stored in column IsWebServiceEnabled in table AD_Role Help: If checked, web services will be able to obtain data for users with this role. It applies to both JSON REST and XML REST web services
`static String`	`PROPERTY_MANUAL`	Property manual stored in column IsManual in table AD_Role Help: The Manual check box indicates if the process will done manually.
`static String`	`PROPERTY_NAME`	Property name stored in column Name in table AD_Role
`static String`	`PROPERTY_OBKMOWIDGETCLASSACCESSLIST`	Property oBKMOWidgetClassAccessList stored in table AD_Role
`static String`	`PROPERTY_OBUIAPPPROCESSACCESSLIST`	Property oBUIAPPProcessAccessList stored in table AD_Role
`static String`	`PROPERTY_OBUIAPPVIEWROLEACCESSLIST`	Property obuiappViewRoleAccessList stored in table AD_Role
`static String`	`PROPERTY_ORGANIZATION`	Property organization stored in column AD_Org_ID in table AD_Role
`static String`	`PROPERTY_PORTALADMIN`	Property portalAdmin stored in column IsPortalAdmin in table AD_Role Help: If checked, the Portal Role will have Portal Administrator privileges
`static String`	`PROPERTY_PRIMARYTREEMENU`	Property primaryTreeMenu stored in column AD_Tree_Menu_ID in table AD_Role Help: Tree Menu
`static String`	`PROPERTY_PROCESSNOW`	Property processNow stored in column Processing in table AD_Role Help: When this field is set as 'Y' a process is being performed on this record.
`static String`	`PROPERTY_RECALCULATEPERMISSIONS`	Property recalculatePermissions stored in column Recalculatepermissions in table AD_Role Help: This process recalculates role permissions, based on the role inheritance defined. Depending on the role type the behavior varies: - If the role is a template one, the permissions for the role will be recalculated and also propagated to every role which is currently inheriting from this template. - If the role is not marked as template, just the permissions for this role are recalculated. For details - http://wiki.openbravo.com/wiki/Role#Permissions_Inheritance
`static String`	`PROPERTY_TEMPLATE`	Property template stored in column IsTemplate in table AD_Role Help: Template is checked when the element is used as a template.
`static String`	`PROPERTY_UPDATED`	Property updated stored in column Updated in table AD_Role
`static String`	`PROPERTY_UPDATEDBY`	Property updatedBy stored in column UpdatedBy in table AD_Role
`static String`	`PROPERTY_USERLEVEL`	Property userLevel stored in column UserLevel in table AD_Role Help: The User Level field determines if users of this Role will have access to System level data, Organization level data, Client level data or Client and Organization level data.
`static String`	`TABLE_NAME`

Fields inherited from class org.openbravo.base.structure.BaseOBObject
ID

Constructor Summary

Constructors
Constructor Description

Role()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<AlertRecipient>`	`getADAlertRecipientList()`	Help: This table contains the recipients of the alert, they can be defined as individual users or as roles.
`List<FormAccess>`	`getADFormAccessList()`	Help: The Form Access Tab defines the Forms and type of access that this Role is granted. The Forms Access Tab defines the access rules for this form
`List<Preference>`	`getADPreferenceVisibleAtRoleList()`	Help: Defines preferences (default values) for a user.
`List<ProcessAccess>`	`getADProcessAccessList()`	Help: The Process Access Tab defines the Processes and type of access that this Role is granted. The Report Access Tab determines who can access a report or process
`List<RoleInheritance>`	`getADRoleInheritanceInheritFromList()`	Help: Defines the roles used by a role to define its access to the different application elements (organizations, windows, processes, reports etc.) retrieved by the inheritance process.
`List<RoleInheritance>`	`getADRoleInheritanceList()`	Help: Defines the roles used by a role to define its access to the different application elements (organizations, windows, processes, reports etc.) retrieved by the inheritance process.
`List<RoleOrganization>`	`getADRoleOrganizationList()`	Help: Add the client organizations the user has access to.
`List<TableAccess>`	`getADTableAccessList()`	Help: If listed here, the Role can(not) access all data of this table, even if the role has access to the functionality
`List<UserRoles>`	`getADUserRolesList()`	Help: The User Roles Tab define the Roles each user may have. The Roles will determine what windows, tasks, processes and workflows that a User has access to. The User Assignment Tab displays Users who have been defined for this Role.
`List<WindowAccess>`	`getADWindowAccessList()`	Help: The Window Access Tab defines the Roles which have access to this Window. The Window Access Tab defines the Windows and type of access that this Role is granted.
`BigDecimal`	`getApprovalAmount()`
`Client`	`getClient()`	Client field
`User`	`getCreatedBy()`	Created by audit user
`Date`	`getCreationDate()`	Creation date of audit
`Currency`	`getCurrency()`
`String`	`getDescription()`
`String`	`getEntityName()`
`String`	`getId()`
`String`	`getName()`
`List<WidgetClassAccess>`	`getOBKMOWidgetClassAccessList()`
`List<ProcessAccess>`	`getOBUIAPPProcessAccessList()`
`List<ViewRoleAccess>`	`getObuiappViewRoleAccessList()`	Help: Defines the access to Openbravo view implementations.
`Organization`	`getOrganization()`	Gets organization field
`Tree`	`getPrimaryTreeMenu()`
`Date`	`getUpdated()`	Update date of audit
`User`	`getUpdatedBy()`	Update by audit user
`String`	`getUserLevel()`
`Boolean`	`isActive()`	Gets active field
`Boolean`	`isAdvanced()`
`Boolean`	`isClientAdmin()`
`Boolean`	`isForPortalUsers()`
`Boolean`	`isManual()`
`Boolean`	`isPortalAdmin()`
`Boolean`	`isProcessNow()`
`Boolean`	`isRecalculatePermissions()`
`Boolean`	`isRestrictbackend()`
`Boolean`	`isTemplate()`
`Boolean`	`isWebServiceEnabled()`
`void`	`setActive(Boolean active)`	Sets active field
`void`	`setADAlertRecipientList(List<AlertRecipient> aDAlertRecipientList)`	Help: This table contains the recipients of the alert, they can be defined as individual users or as roles.
`void`	`setADFormAccessList(List<FormAccess> aDFormAccessList)`	Help: The Form Access Tab defines the Forms and type of access that this Role is granted. The Forms Access Tab defines the access rules for this form
`void`	`setADPreferenceVisibleAtRoleList(List<Preference> aDPreferenceVisibleAtRoleList)`	Help: Defines preferences (default values) for a user.
`void`	`setADProcessAccessList(List<ProcessAccess> aDProcessAccessList)`	Help: The Process Access Tab defines the Processes and type of access that this Role is granted. The Report Access Tab determines who can access a report or process
`void`	`setADRoleInheritanceInheritFromList(List<RoleInheritance> aDRoleInheritanceInheritFromList)`	Help: Defines the roles used by a role to define its access to the different application elements (organizations, windows, processes, reports etc.) retrieved by the inheritance process.
`void`	`setADRoleInheritanceList(List<RoleInheritance> aDRoleInheritanceList)`	Help: Defines the roles used by a role to define its access to the different application elements (organizations, windows, processes, reports etc.) retrieved by the inheritance process.
`void`	`setADRoleOrganizationList(List<RoleOrganization> aDRoleOrganizationList)`	Help: Add the client organizations the user has access to.
`void`	`setADTableAccessList(List<TableAccess> aDTableAccessList)`	Help: If listed here, the Role can(not) access all data of this table, even if the role has access to the functionality
`void`	`setADUserRolesList(List<UserRoles> aDUserRolesList)`	Help: The User Roles Tab define the Roles each user may have. The Roles will determine what windows, tasks, processes and workflows that a User has access to. The User Assignment Tab displays Users who have been defined for this Role.
`void`	`setAdvanced(Boolean advanced)`
`void`	`setADWindowAccessList(List<WindowAccess> aDWindowAccessList)`	Help: The Window Access Tab defines the Roles which have access to this Window. The Window Access Tab defines the Windows and type of access that this Role is granted.
`void`	`setApprovalAmount(BigDecimal approvalAmount)`
`void`	`setClient(Client client)`	Client field
`void`	`setClientAdmin(Boolean clientAdmin)`
`void`	`setCreatedBy(User createdBy)`	Created by audit user
`void`	`setCreationDate(Date creationDate)`	Creation date of audit
`void`	`setCurrency(Currency currency)`
`void`	`setDescription(String description)`
`void`	`setForPortalUsers(Boolean forPortalUsers)`
`void`	`setId(String id)`
`void`	`setManual(Boolean manual)`
`void`	`setName(String name)`
`void`	`setOBKMOWidgetClassAccessList(List<WidgetClassAccess> oBKMOWidgetClassAccessList)`
`void`	`setOBUIAPPProcessAccessList(List<ProcessAccess> oBUIAPPProcessAccessList)`
`void`	`setObuiappViewRoleAccessList(List<ViewRoleAccess> obuiappViewRoleAccessList)`	Help: Defines the access to Openbravo view implementations.
`void`	`setOrganization(Organization organization)`	Sets organization field
`void`	`setPortalAdmin(Boolean portalAdmin)`
`void`	`setPrimaryTreeMenu(Tree primaryTreeMenu)`
`void`	`setProcessNow(Boolean processNow)`
`void`	`setRecalculatePermissions(Boolean recalculatePermissions)`
`void`	`setRestrictbackend(Boolean isrestrictbackend)`
`void`	`setTemplate(Boolean template)`
`void`	`setUpdated(Date updated)`	Update date of audit
`void`	`setUpdatedBy(User updatedBy)`	Update by audit user
`void`	`setUserLevel(String userLevel)`
`void`	`setWebServiceEnabled(Boolean isWebServiceEnabled)`

Methods inherited from class org.openbravo.base.structure.BaseOBObject
checkDerivedReadable, get, get, get, getEntity, getIdentifier, getValue, isAllowRead, isNewOBObject, isOrgClientAccessCheckEnabled, isWriteAccessCheckEnabled, set, setAccessChecks, setAllowRead, setDefaultValue, setId, setNewOBObject, setValue, toString, validate

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

- Field Detail
  - TABLE_NAME
```
public static final String TABLE_NAME
```
    See Also:
    
    Constant Field Values
  - ENTITY_NAME
```
public static final String ENTITY_NAME
```
    See Also:
    
    Constant Field Values
  - PROPERTY_ID
```
public static final String PROPERTY_ID
```
    Property id stored in column AD_Role_ID in table AD_Role
    Help: The Role determines security and access a user who has this Role will have in the System.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CLIENT
```
public static final String PROPERTY_CLIENT
```
    Property client stored in column AD_Client_ID in table AD_Role
    
    See Also:
    
    ClientEnabled, Constant Field Values
  - PROPERTY_ORGANIZATION
```
public static final String PROPERTY_ORGANIZATION
```
    Property organization stored in column AD_Org_ID in table AD_Role
    
    See Also:
    
    OrganizationEnabled, Constant Field Values
  - PROPERTY_ACTIVE
```
public static final String PROPERTY_ACTIVE
```
    Property active stored in column IsActive in table AD_Role
    
    See Also:
    
    ActiveEnabled, Constant Field Values
  - PROPERTY_CREATIONDATE
```
public static final String PROPERTY_CREATIONDATE
```
    Property creationDate stored in column Created in table AD_Role
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_CREATEDBY
```
public static final String PROPERTY_CREATEDBY
```
    Property createdBy stored in column CreatedBy in table AD_Role
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_UPDATED
```
public static final String PROPERTY_UPDATED
```
    Property updated stored in column Updated in table AD_Role
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_NAME
```
public static final String PROPERTY_NAME
```
    Property name stored in column Name in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_UPDATEDBY
```
public static final String PROPERTY_UPDATEDBY
```
    Property updatedBy stored in column UpdatedBy in table AD_Role
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_DESCRIPTION
```
public static final String PROPERTY_DESCRIPTION
```
    Property description stored in column Description in table AD_Role
    Help: A description is limited to 255 characters.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_USERLEVEL
```
public static final String PROPERTY_USERLEVEL
```
    Property userLevel stored in column UserLevel in table AD_Role
    Help: The User Level field determines if users of this Role will have access to System level data, Organization level data, Client level data or Client and Organization level data.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CURRENCY
```
public static final String PROPERTY_CURRENCY
```
    Property currency stored in column C_Currency_ID in table AD_Role
    Help: Indicates the currency to be used when processing this document.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_APPROVALAMOUNT
```
public static final String PROPERTY_APPROVALAMOUNT
```
    Property approvalAmount stored in column AmtApproval in table AD_Role
    Help: The Approval Amount field indicates the amount limit this Role has for approval of documents.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PRIMARYTREEMENU
```
public static final String PROPERTY_PRIMARYTREEMENU
```
    Property primaryTreeMenu stored in column AD_Tree_Menu_ID in table AD_Role
    Help: Tree Menu
    
    See Also:
    
    Constant Field Values
  - PROPERTY_MANUAL
```
public static final String PROPERTY_MANUAL
```
    Property manual stored in column IsManual in table AD_Role
    Help: The Manual check box indicates if the process will done manually.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PROCESSNOW
```
public static final String PROPERTY_PROCESSNOW
```
    Property processNow stored in column Processing in table AD_Role
    Help: When this field is set as 'Y' a process is being performed on this record.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CLIENTADMIN
```
public static final String PROPERTY_CLIENTADMIN
```
    Property clientAdmin stored in column IS_Client_Admin in table AD_Role
    Help: Defines the role as an administrator of the client it belongs to.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADVANCED
```
public static final String PROPERTY_ADVANCED
```
    Property advanced stored in column IsAdvanced in table AD_Role
    Help: Automatic (non manual) advanced roles are granted with features checked as advanced.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ISRESTRICTBACKEND
```
public static final String PROPERTY_ISRESTRICTBACKEND
```
    Property isrestrictbackend stored in column Isrestrictbackend in table AD_Role
    Help: If checked, this role will not have access to the backend. It will however have access to other applications (such as the WebPOS)
    
    See Also:
    
    Constant Field Values
  - PROPERTY_FORPORTALUSERS
```
public static final String PROPERTY_FORPORTALUSERS
```
    Property forPortalUsers stored in column IsPortal in table AD_Role
    Help: If checked, this role will have a simplified (portal) interface, where it only has available the workspace widgets.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PORTALADMIN
```
public static final String PROPERTY_PORTALADMIN
```
    Property portalAdmin stored in column IsPortalAdmin in table AD_Role
    Help: If checked, the Portal Role will have Portal Administrator privileges
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ISWEBSERVICEENABLED
```
public static final String PROPERTY_ISWEBSERVICEENABLED
```
    Property isWebServiceEnabled stored in column IsWebServiceEnabled in table AD_Role
    Help: If checked, web services will be able to obtain data for users with this role. It applies to both JSON REST and XML REST web services
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TEMPLATE
```
public static final String PROPERTY_TEMPLATE
```
    Property template stored in column IsTemplate in table AD_Role
    Help: Template is checked when the element is used as a template.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_RECALCULATEPERMISSIONS
```
public static final String PROPERTY_RECALCULATEPERMISSIONS
```
    Property recalculatePermissions stored in column Recalculatepermissions in table AD_Role
    Help: This process recalculates role permissions, based on the role inheritance defined. Depending on the role type the behavior varies: - If the role is a template one, the permissions for the role will be recalculated and also propagated to every role which is currently inheriting from this template. - If the role is not marked as template, just the permissions for this role are recalculated. For details - http://wiki.openbravo.com/wiki/Role#Permissions_Inheritance
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADALERTRECIPIENTLIST
```
public static final String PROPERTY_ADALERTRECIPIENTLIST
```
    Property aDAlertRecipientList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADFORMACCESSLIST
```
public static final String PROPERTY_ADFORMACCESSLIST
```
    Property aDFormAccessList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADPREFERENCEVISIBLEATROLELIST
```
public static final String PROPERTY_ADPREFERENCEVISIBLEATROLELIST
```
    Property aDPreferenceVisibleAtRoleList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADPROCESSACCESSLIST
```
public static final String PROPERTY_ADPROCESSACCESSLIST
```
    Property aDProcessAccessList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADROLEINHERITANCEINHERITFROMLIST
```
public static final String PROPERTY_ADROLEINHERITANCEINHERITFROMLIST
```
    Property aDRoleInheritanceInheritFromList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADROLEINHERITANCELIST
```
public static final String PROPERTY_ADROLEINHERITANCELIST
```
    Property aDRoleInheritanceList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADROLEORGANIZATIONLIST
```
public static final String PROPERTY_ADROLEORGANIZATIONLIST
```
    Property aDRoleOrganizationList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADTABLEACCESSLIST
```
public static final String PROPERTY_ADTABLEACCESSLIST
```
    Property aDTableAccessList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADUSERROLESLIST
```
public static final String PROPERTY_ADUSERROLESLIST
```
    Property aDUserRolesList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ADWINDOWACCESSLIST
```
public static final String PROPERTY_ADWINDOWACCESSLIST
```
    Property aDWindowAccessList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_OBKMOWIDGETCLASSACCESSLIST
```
public static final String PROPERTY_OBKMOWIDGETCLASSACCESSLIST
```
    Property oBKMOWidgetClassAccessList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_OBUIAPPPROCESSACCESSLIST
```
public static final String PROPERTY_OBUIAPPPROCESSACCESSLIST
```
    Property oBUIAPPProcessAccessList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
  - PROPERTY_OBUIAPPVIEWROLEACCESSLIST
```
public static final String PROPERTY_OBUIAPPVIEWROLEACCESSLIST
```
    Property obuiappViewRoleAccessList stored in table AD_Role
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Role
```
public Role()
```
- Method Detail
  - getEntityName
```
public String getEntityName()
```
    Specified by:
    
    getEntityName in interface Identifiable
    
    Specified by:
    
    getEntityName in class BaseOBObject
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface BaseOBObjectDef
    
    Specified by:
    
    getId in interface Identifiable
    
    Overrides:
    
    getId in class BaseOBObject
    
    See Also:
    
    PROPERTY_ID
  - setId
```
public void setId(String id)
```
    See Also:
    
    PROPERTY_ID
  - getClient
```
public Client getClient()
```
    Description copied from interface: ClientEnabled
    
    Client field
    
    Specified by:
    
    getClient in interface ClientEnabled
    
    Returns:
    
    client
    
    See Also:
    
    PROPERTY_CLIENT
  - setClient
```
public void setClient(Client client)
```
    Description copied from interface: ClientEnabled
    
    Client field
    
    Specified by:
    
    setClient in interface ClientEnabled
    
    See Also:
    
    PROPERTY_CLIENT
  - getOrganization
```
public Organization getOrganization()
```
    Description copied from interface: OrganizationEnabled
    
    Gets organization field
    
    Specified by:
    
    getOrganization in interface OrganizationEnabled
    
    Returns:
    
    organization
    
    See Also:
    
    PROPERTY_ORGANIZATION
  - setOrganization
```
public void setOrganization(Organization organization)
```
    Description copied from interface: OrganizationEnabled
    
    Sets organization field
    
    Specified by:
    
    setOrganization in interface OrganizationEnabled
    
    See Also:
    
    PROPERTY_ORGANIZATION
  - isActive
```
public Boolean isActive()
```
    Description copied from interface: ActiveEnabled
    
    Gets active field
    
    Specified by:
    
    isActive in interface ActiveEnabled
    
    Returns:
    
    active
    
    See Also:
    
    PROPERTY_ACTIVE
  - setActive
```
public void setActive(Boolean active)
```
    Description copied from interface: ActiveEnabled
    
    Sets active field
    
    Specified by:
    
    setActive in interface ActiveEnabled
    
    See Also:
    
    PROPERTY_ACTIVE
  - getCreationDate
```
public Date getCreationDate()
```
    Description copied from interface: Traceable
    
    Creation date of audit
    
    Specified by:
    
    getCreationDate in interface Traceable
    
    Returns:
    
    Date of creation
    
    See Also:
    
    PROPERTY_CREATIONDATE
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    Description copied from interface: Traceable
    
    Creation date of audit
    
    Specified by:
    
    setCreationDate in interface Traceable
    
    See Also:
    
    PROPERTY_CREATIONDATE
  - getCreatedBy
```
public User getCreatedBy()
```
    Description copied from interface: Traceable
    
    Created by audit user
    
    Specified by:
    
    getCreatedBy in interface Traceable
    
    Returns:
    
    User
    
    See Also:
    
    PROPERTY_CREATEDBY
  - setCreatedBy
```
public void setCreatedBy(User createdBy)
```
    Description copied from interface: Traceable
    
    Created by audit user
    
    Specified by:
    
    setCreatedBy in interface Traceable
    
    See Also:
    
    PROPERTY_CREATEDBY
  - getUpdated
```
public Date getUpdated()
```
    Description copied from interface: Traceable
    
    Update date of audit
    
    Specified by:
    
    getUpdated in interface Traceable
    
    Returns:
    
    Date of update
    
    See Also:
    
    PROPERTY_UPDATED
  - setUpdated
```
public void setUpdated(Date updated)
```
    Description copied from interface: Traceable
    
    Update date of audit
    
    Specified by:
    
    setUpdated in interface Traceable
    
    See Also:
    
    PROPERTY_UPDATED
  - getName
```
public String getName()
```
    See Also:
    
    PROPERTY_NAME
  - setName
```
public void setName(String name)
```
    See Also:
    
    PROPERTY_NAME
  - getUpdatedBy
```
public User getUpdatedBy()
```
    Description copied from interface: Traceable
    
    Update by audit user
    
    Specified by:
    
    getUpdatedBy in interface Traceable
    
    Returns:
    
    User who updated
    
    See Also:
    
    PROPERTY_UPDATEDBY
  - setUpdatedBy
```
public void setUpdatedBy(User updatedBy)
```
    Description copied from interface: Traceable
    
    Update by audit user
    
    Specified by:
    
    setUpdatedBy in interface Traceable
    
    See Also:
    
    PROPERTY_UPDATEDBY
  - getDescription
```
public String getDescription()
```
    See Also:
    
    PROPERTY_DESCRIPTION
  - setDescription
```
public void setDescription(String description)
```
    See Also:
    
    PROPERTY_DESCRIPTION
  - getUserLevel
```
public String getUserLevel()
```
    See Also:
    
    PROPERTY_USERLEVEL
  - setUserLevel
```
public void setUserLevel(String userLevel)
```
    See Also:
    
    PROPERTY_USERLEVEL
  - getCurrency
```
public Currency getCurrency()
```
    See Also:
    
    PROPERTY_CURRENCY
  - setCurrency
```
public void setCurrency(Currency currency)
```
    See Also:
    
    PROPERTY_CURRENCY
  - getApprovalAmount
```
public BigDecimal getApprovalAmount()
```
    See Also:
    
    PROPERTY_APPROVALAMOUNT
  - setApprovalAmount
```
public void setApprovalAmount(BigDecimal approvalAmount)
```
    See Also:
    
    PROPERTY_APPROVALAMOUNT
  - getPrimaryTreeMenu
```
public Tree getPrimaryTreeMenu()
```
    See Also:
    
    PROPERTY_PRIMARYTREEMENU
  - setPrimaryTreeMenu
```
public void setPrimaryTreeMenu(Tree primaryTreeMenu)
```
    See Also:
    
    PROPERTY_PRIMARYTREEMENU
  - isManual
```
public Boolean isManual()
```
    See Also:
    
    PROPERTY_MANUAL
  - setManual
```
public void setManual(Boolean manual)
```
    See Also:
    
    PROPERTY_MANUAL
  - isProcessNow
```
public Boolean isProcessNow()
```
    See Also:
    
    PROPERTY_PROCESSNOW
  - setProcessNow
```
public void setProcessNow(Boolean processNow)
```
    See Also:
    
    PROPERTY_PROCESSNOW
  - isClientAdmin
```
public Boolean isClientAdmin()
```
    See Also:
    
    PROPERTY_CLIENTADMIN
  - setClientAdmin
```
public void setClientAdmin(Boolean clientAdmin)
```
    See Also:
    
    PROPERTY_CLIENTADMIN
  - isAdvanced
```
public Boolean isAdvanced()
```
    See Also:
    
    PROPERTY_ADVANCED
  - setAdvanced
```
public void setAdvanced(Boolean advanced)
```
    See Also:
    
    PROPERTY_ADVANCED
  - isRestrictbackend
```
public Boolean isRestrictbackend()
```
    See Also:
    
    PROPERTY_ISRESTRICTBACKEND
  - setRestrictbackend
```
public void setRestrictbackend(Boolean isrestrictbackend)
```
    See Also:
    
    PROPERTY_ISRESTRICTBACKEND
  - isForPortalUsers
```
public Boolean isForPortalUsers()
```
    See Also:
    
    PROPERTY_FORPORTALUSERS
  - setForPortalUsers
```
public void setForPortalUsers(Boolean forPortalUsers)
```
    See Also:
    
    PROPERTY_FORPORTALUSERS
  - isPortalAdmin
```
public Boolean isPortalAdmin()
```
    See Also:
    
    PROPERTY_PORTALADMIN
  - setPortalAdmin
```
public void setPortalAdmin(Boolean portalAdmin)
```
    See Also:
    
    PROPERTY_PORTALADMIN
  - isWebServiceEnabled
```
public Boolean isWebServiceEnabled()
```
    See Also:
    
    PROPERTY_ISWEBSERVICEENABLED
  - setWebServiceEnabled
```
public void setWebServiceEnabled(Boolean isWebServiceEnabled)
```
    See Also:
    
    PROPERTY_ISWEBSERVICEENABLED
  - isTemplate
```
public Boolean isTemplate()
```
    See Also:
    
    PROPERTY_TEMPLATE
  - setTemplate
```
public void setTemplate(Boolean template)
```
    See Also:
    
    PROPERTY_TEMPLATE
  - isRecalculatePermissions
```
public Boolean isRecalculatePermissions()
```
    See Also:
    
    PROPERTY_RECALCULATEPERMISSIONS
  - setRecalculatePermissions
```
public void setRecalculatePermissions(Boolean recalculatePermissions)
```
    See Also:
    
    PROPERTY_RECALCULATEPERMISSIONS
  - getADAlertRecipientList
```
public List<AlertRecipient> getADAlertRecipientList()
```
    Help: This table contains the recipients of the alert, they can be defined as individual users or as roles.
    
    See Also:
    
    AlertRecipient
  - setADAlertRecipientList
```
public void setADAlertRecipientList(List<AlertRecipient> aDAlertRecipientList)
```
    Help: This table contains the recipients of the alert, they can be defined as individual users or as roles.
    
    See Also:
    
    AlertRecipient
  - getADFormAccessList
```
public List<FormAccess> getADFormAccessList()
```
    Help: The Form Access Tab defines the Forms and type of access that this Role is granted. The Forms Access Tab defines the access rules for this form
    
    See Also:
    
    FormAccess
  - setADFormAccessList
```
public void setADFormAccessList(List<FormAccess> aDFormAccessList)
```
    Help: The Form Access Tab defines the Forms and type of access that this Role is granted. The Forms Access Tab defines the access rules for this form
    
    See Also:
    
    FormAccess
  - getADPreferenceVisibleAtRoleList
```
public List<Preference> getADPreferenceVisibleAtRoleList()
```
    Help: Defines preferences (default values) for a user.
    
    See Also:
    
    Preference
  - setADPreferenceVisibleAtRoleList
```
public void setADPreferenceVisibleAtRoleList(List<Preference> aDPreferenceVisibleAtRoleList)
```
    Help: Defines preferences (default values) for a user.
    
    See Also:
    
    Preference
  - getADProcessAccessList
```
public List<ProcessAccess> getADProcessAccessList()
```
    Help: The Process Access Tab defines the Processes and type of access that this Role is granted. The Report Access Tab determines who can access a report or process
    
    See Also:
    
    ProcessAccess
  - setADProcessAccessList
```
public void setADProcessAccessList(List<ProcessAccess> aDProcessAccessList)
```
    Help: The Process Access Tab defines the Processes and type of access that this Role is granted. The Report Access Tab determines who can access a report or process
    
    See Also:
    
    ProcessAccess
  - getADRoleInheritanceInheritFromList
```
public List<RoleInheritance> getADRoleInheritanceInheritFromList()
```
    Help: Defines the roles used by a role to define its access to the different application elements (organizations, windows, processes, reports etc.) retrieved by the inheritance process.
    
    See Also:
    
    RoleInheritance
  - setADRoleInheritanceInheritFromList
```
public void setADRoleInheritanceInheritFromList(List<RoleInheritance> aDRoleInheritanceInheritFromList)
```
    Help: Defines the roles used by a role to define its access to the different application elements (organizations, windows, processes, reports etc.) retrieved by the inheritance process.
    
    See Also:
    
    RoleInheritance
  - getADRoleInheritanceList
```
public List<RoleInheritance> getADRoleInheritanceList()
```
    Help: Defines the roles used by a role to define its access to the different application elements (organizations, windows, processes, reports etc.) retrieved by the inheritance process.
    
    See Also:
    
    RoleInheritance
  - setADRoleInheritanceList
```
public void setADRoleInheritanceList(List<RoleInheritance> aDRoleInheritanceList)
```
    Help: Defines the roles used by a role to define its access to the different application elements (organizations, windows, processes, reports etc.) retrieved by the inheritance process.
    
    See Also:
    
    RoleInheritance
  - getADRoleOrganizationList
```
public List<RoleOrganization> getADRoleOrganizationList()
```
    Help: Add the client organizations the user has access to.
    
    See Also:
    
    RoleOrganization
  - setADRoleOrganizationList
```
public void setADRoleOrganizationList(List<RoleOrganization> aDRoleOrganizationList)
```
    Help: Add the client organizations the user has access to.
    
    See Also:
    
    RoleOrganization
  - getADTableAccessList
```
public List<TableAccess> getADTableAccessList()
```
    Help: If listed here, the Role can(not) access all data of this table, even if the role has access to the functionality
    
    See Also:
    
    TableAccess
  - setADTableAccessList
```
public void setADTableAccessList(List<TableAccess> aDTableAccessList)
```
    Help: If listed here, the Role can(not) access all data of this table, even if the role has access to the functionality
    
    See Also:
    
    TableAccess
  - getADUserRolesList
```
public List<UserRoles> getADUserRolesList()
```
    Help: The User Roles Tab define the Roles each user may have. The Roles will determine what windows, tasks, processes and workflows that a User has access to. The User Assignment Tab displays Users who have been defined for this Role.
    
    See Also:
    
    UserRoles
  - setADUserRolesList
```
public void setADUserRolesList(List<UserRoles> aDUserRolesList)
```
    Help: The User Roles Tab define the Roles each user may have. The Roles will determine what windows, tasks, processes and workflows that a User has access to. The User Assignment Tab displays Users who have been defined for this Role.
    
    See Also:
    
    UserRoles
  - getADWindowAccessList
```
public List<WindowAccess> getADWindowAccessList()
```
    Help: The Window Access Tab defines the Roles which have access to this Window. The Window Access Tab defines the Windows and type of access that this Role is granted.
    
    See Also:
    
    WindowAccess
  - setADWindowAccessList
```
public void setADWindowAccessList(List<WindowAccess> aDWindowAccessList)
```
    Help: The Window Access Tab defines the Roles which have access to this Window. The Window Access Tab defines the Windows and type of access that this Role is granted.
    
    See Also:
    
    WindowAccess
  - getOBKMOWidgetClassAccessList
```
public List<WidgetClassAccess> getOBKMOWidgetClassAccessList()
```
    See Also:
    
    WidgetClassAccess
  - setOBKMOWidgetClassAccessList
```
public void setOBKMOWidgetClassAccessList(List<WidgetClassAccess> oBKMOWidgetClassAccessList)
```
    See Also:
    
    WidgetClassAccess
  - getOBUIAPPProcessAccessList
```
public List<ProcessAccess> getOBUIAPPProcessAccessList()
```
    See Also:
    
    ProcessAccess
  - setOBUIAPPProcessAccessList
```
public void setOBUIAPPProcessAccessList(List<ProcessAccess> oBUIAPPProcessAccessList)
```
    See Also:
    
    ProcessAccess
  - getObuiappViewRoleAccessList
```
public List<ViewRoleAccess> getObuiappViewRoleAccessList()
```
    Help: Defines the access to Openbravo view implementations.
    
    See Also:
    
    ViewRoleAccess
  - setObuiappViewRoleAccessList
```
public void setObuiappViewRoleAccessList(List<ViewRoleAccess> obuiappViewRoleAccessList)
```
    Help: Defines the access to Openbravo view implementations.
    
    See Also:
    
    ViewRoleAccess

Class Role

Field Summary

Fields inherited from class org.openbravo.base.structure.BaseOBObject

Constructor Summary

Method Summary

Methods inherited from class org.openbravo.base.structure.BaseOBObject

Methods inherited from class java.lang.Object

Field Detail

TABLE_NAME

ENTITY_NAME

PROPERTY_ID

PROPERTY_CLIENT

PROPERTY_ORGANIZATION

PROPERTY_ACTIVE

PROPERTY_CREATIONDATE

PROPERTY_CREATEDBY

PROPERTY_UPDATED

PROPERTY_NAME

PROPERTY_UPDATEDBY

PROPERTY_DESCRIPTION

PROPERTY_USERLEVEL

PROPERTY_CURRENCY

PROPERTY_APPROVALAMOUNT

PROPERTY_PRIMARYTREEMENU

PROPERTY_MANUAL

PROPERTY_PROCESSNOW

PROPERTY_CLIENTADMIN

PROPERTY_ADVANCED

PROPERTY_ISRESTRICTBACKEND

PROPERTY_FORPORTALUSERS

PROPERTY_PORTALADMIN

PROPERTY_ISWEBSERVICEENABLED

PROPERTY_TEMPLATE

PROPERTY_RECALCULATEPERMISSIONS

PROPERTY_ADALERTRECIPIENTLIST

PROPERTY_ADFORMACCESSLIST

PROPERTY_ADPREFERENCEVISIBLEATROLELIST

PROPERTY_ADPROCESSACCESSLIST

PROPERTY_ADROLEINHERITANCEINHERITFROMLIST

PROPERTY_ADROLEINHERITANCELIST

PROPERTY_ADROLEORGANIZATIONLIST

PROPERTY_ADTABLEACCESSLIST

PROPERTY_ADUSERROLESLIST

PROPERTY_ADWINDOWACCESSLIST

PROPERTY_OBKMOWIDGETCLASSACCESSLIST

PROPERTY_OBUIAPPPROCESSACCESSLIST

PROPERTY_OBUIAPPVIEWROLEACCESSLIST

Constructor Detail

Role

Method Detail

getEntityName

getId

setId

getClient

setClient

getOrganization

setOrganization

isActive

setActive

getCreationDate

setCreationDate

getCreatedBy

setCreatedBy

getUpdated

setUpdated

getName

setName

getUpdatedBy

setUpdatedBy

getDescription

setDescription

getUserLevel

setUserLevel

getCurrency

setCurrency

getApprovalAmount

setApprovalAmount

getPrimaryTreeMenu

setPrimaryTreeMenu

isManual