View source | Discuss this page | Page history | Printable version   
Main Page
Upload file
What links here
Recent changes

PDF Books
Add page
Show collection (0 pages)
Collections help


ERP/3.0/Developers Guide/Reference/Entity Model/ADRole

This article is protected against manual editing because it is automatically generated from Openbravo meta-data. Learn more about writing and translating such documents.
Back button.png   Back to ERP/3.0/Developers_Guide/Reference/Entity_Model#ADRole


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.
If the Role User Level is Manual, the as Select Role for with Data Access Restrictions

To the database table (AD_Role) of this entity.



Property Column Constraints Type Description
id* AD_Role_ID Mandatory
Max Length: 32
java.lang.String The Role determines security and access a user who has this Role will have in the System.
client AD_Client_ID Mandatory
ADClient A Client is a company or a legal entity. You cannot share data between Clients.
organization AD_Org_ID Mandatory
Organization An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations.
active IsActive Mandatory
java.lang.Boolean There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reporting. There are two reasons for de-activating and not deleting records:

(1) The system requires the record for auditing purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are existing invoices for it. By de-activating the Business Partner you prevent it from being used in future transactions.

creationDate Created Mandatory
java.util.Date The Created field indicates the date that this record was created.
createdBy CreatedBy Mandatory
ADUser The Created By field indicates the user who created this record.
updated Updated Mandatory
java.util.Date The Updated field indicates the date that this record was updated.
name# Name Mandatory
Max Length: 60
java.lang.String A more descriptive identifier (that does need to be unique) of a record/document that is used as a default search option along with the search key (that is unique and mostly shorter). It is up to 60 characters in length.
updatedBy UpdatedBy Mandatory
ADUser The Updated By field indicates the user who updated this record.
description Description Max Length: 255
java.lang.String A description is limited to 255 characters.
userLevel UserLevel Mandatory
Max Length: 60
java.lang.String 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.
currency C_Currency_ID Currency Indicates the currency to be used when processing this document.
approvalAmount AmtApproval java.math.BigDecimal The Approval Amount field indicates the amount limit this Role has for approval of documents.
primaryTreeMenu AD_Tree_Menu_ID ADTree Tree Menu
manual IsManual java.lang.Boolean The Manual check box indicates if the process will done manually.
processNow Processing java.lang.Boolean When this field is set as 'Y' a process is being performed on this record.
clientAdmin IS_Client_Admin Mandatory
java.lang.Boolean Defines the role as an administrator of the client it belongs to.
advanced IsAdvanced Mandatory
java.lang.Boolean Automatic (non manual) advanced roles are granted with features checked as advanced.
isrestrictbackend Isrestrictbackend Mandatory
java.lang.Boolean If checked, this role will not have access to the backend (ERP). It will however have access to other applications (such as the WebPOS)
forPortalUsers IsPortal Mandatory
java.lang.Boolean If checked, this role will have a simplified (portal) interface, where it only has available the workspace widgets.
portalAdmin IsPortalAdmin Mandatory
java.lang.Boolean If checked, the Portal Role will have Portal Administrator privileges
isWebServiceEnabled IsWebServiceEnabled Mandatory
java.lang.Boolean 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
template IsTemplate Mandatory
java.lang.Boolean Template is checked when the element is used as a template.
recalculatePermissions Recalculatepermissions java.lang.Boolean 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 -

aDAlertRecipientList ADAlertRecipient
aDFormAccessList ADFormAccess
aDPreferenceVisibleAtRoleList ADPreference
aDProcessAccessList ADProcessAccess
aDRoleInheritanceInheritFromList ADRoleInheritance
aDRoleInheritanceList ADRoleInheritance
aDRoleOrganizationList ADRoleOrganization
aDTableAccessList ADTableAccess
aDUserRolesList ADUserRoles
aDWindowAccessList ADWindowAccess
oBKMOWidgetClassAccessList OBKMO_WidgetClassAccess
oBUIAPPProcessAccessList OBUIAPP_Process_Access
obuiappViewRoleAccessList obuiapp_ViewRoleAccess

Java Entity Class

  * The contents of this file are subject to the Openbravo  Public  License
  * Version  1.1  (the  "License"),  being   the  Mozilla   Public  License
  * Version 1.1  with a permitted attribution clause; you may not  use this
  * file except in compliance with the License. You  may  obtain  a copy of
  * the License at
  * Software distributed under the License  is  distributed  on  an "AS IS"
  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
  * License for the specific  language  governing  rights  and  limitations
  * under the License.
  * The Original Code is Openbravo ERP.
  * The Initial Developer of the Original Code is Openbravo SLU
  * All portions are Copyright (C) 2008-2019 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
 import java.math.BigDecimal;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 import org.openbravo.base.structure.ActiveEnabled;
 import org.openbravo.base.structure.BaseOBObject;
 import org.openbravo.base.structure.ClientEnabled;
 import org.openbravo.base.structure.OrganizationEnabled;
 import org.openbravo.base.structure.Traceable;
 import org.openbravo.client.application.ViewRoleAccess;
 import org.openbravo.client.myob.WidgetClassAccess;
 import org.openbravo.model.common.currency.Currency;
 import org.openbravo.model.common.enterprise.Organization;
  * Entity class for entity ADRole (stored in table AD_Role).
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 public class Role extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "AD_Role";
     public static final String ENTITY_NAME = "ADRole";
     public static final String PROPERTY_ID = "id";
     public static final String PROPERTY_CLIENT = "client";
     public static final String PROPERTY_ORGANIZATION = "organization";
     public static final String PROPERTY_ACTIVE = "active";
     public static final String PROPERTY_CREATIONDATE = "creationDate";
     public static final String PROPERTY_CREATEDBY = "createdBy";
     public static final String PROPERTY_UPDATED = "updated";
     public static final String PROPERTY_NAME = "name";
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
     public static final String PROPERTY_DESCRIPTION = "description";
     public static final String PROPERTY_USERLEVEL = "userLevel";
     public static final String PROPERTY_CURRENCY = "currency";
     public static final String PROPERTY_APPROVALAMOUNT = "approvalAmount";
     public static final String PROPERTY_PRIMARYTREEMENU = "primaryTreeMenu";
     public static final String PROPERTY_MANUAL = "manual";
     public static final String PROPERTY_PROCESSNOW = "processNow";
     public static final String PROPERTY_CLIENTADMIN = "clientAdmin";
     public static final String PROPERTY_ADVANCED = "advanced";
     public static final String PROPERTY_ISRESTRICTBACKEND = "isrestrictbackend";
     public static final String PROPERTY_FORPORTALUSERS = "forPortalUsers";
     public static final String PROPERTY_PORTALADMIN = "portalAdmin";
     public static final String PROPERTY_ISWEBSERVICEENABLED = "isWebServiceEnabled";
     public static final String PROPERTY_TEMPLATE = "template";
     public static final String PROPERTY_RECALCULATEPERMISSIONS = "recalculatePermissions";
     public static final String PROPERTY_ADALERTRECIPIENTLIST = "aDAlertRecipientList";
     public static final String PROPERTY_ADFORMACCESSLIST = "aDFormAccessList";
     public static final String PROPERTY_ADPREFERENCEVISIBLEATROLELIST = "aDPreferenceVisibleAtRoleList";
     public static final String PROPERTY_ADPROCESSACCESSLIST = "aDProcessAccessList";
     public static final String PROPERTY_ADROLEINHERITANCEINHERITFROMLIST = "aDRoleInheritanceInheritFromList";
     public static final String PROPERTY_ADROLEINHERITANCELIST = "aDRoleInheritanceList";
     public static final String PROPERTY_ADROLEORGANIZATIONLIST = "aDRoleOrganizationList";
     public static final String PROPERTY_ADTABLEACCESSLIST = "aDTableAccessList";
     public static final String PROPERTY_ADUSERROLESLIST = "aDUserRolesList";
     public static final String PROPERTY_ADWINDOWACCESSLIST = "aDWindowAccessList";
     public static final String PROPERTY_OBKMOWIDGETCLASSACCESSLIST = "oBKMOWidgetClassAccessList";
     public static final String PROPERTY_OBUIAPPPROCESSACCESSLIST = "oBUIAPPProcessAccessList";
     public static final String PROPERTY_OBUIAPPVIEWROLEACCESSLIST = "obuiappViewRoleAccessList";
     public Role() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_MANUAL, true);
         setDefaultValue(PROPERTY_PROCESSNOW, false);
         setDefaultValue(PROPERTY_CLIENTADMIN, false);
         setDefaultValue(PROPERTY_ADVANCED, false);
         setDefaultValue(PROPERTY_ISRESTRICTBACKEND, false);
         setDefaultValue(PROPERTY_FORPORTALUSERS, false);
         setDefaultValue(PROPERTY_PORTALADMIN, false);
         setDefaultValue(PROPERTY_ISWEBSERVICEENABLED, false);
         setDefaultValue(PROPERTY_TEMPLATE, false);
         setDefaultValue(PROPERTY_RECALCULATEPERMISSIONS, false);
         setDefaultValue(PROPERTY_ADALERTRECIPIENTLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_ADFORMACCESSLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_ADPREFERENCEVISIBLEATROLELIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_ADPROCESSACCESSLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_ADROLEINHERITANCEINHERITFROMLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_ADROLEINHERITANCELIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_ADROLEORGANIZATIONLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_ADTABLEACCESSLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_ADUSERROLESLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_ADWINDOWACCESSLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBKMOWIDGETCLASSACCESSLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUIAPPPROCESSACCESSLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUIAPPVIEWROLEACCESSLIST, new ArrayList<Object>());
     public String getEntityName() {
         return ENTITY_NAME;
     public String getId() {
         return (String) get(PROPERTY_ID);
     public void setId(String id) {
         set(PROPERTY_ID, id);
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     public String getName() {
         return (String) get(PROPERTY_NAME);
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     public String getDescription() {
         return (String) get(PROPERTY_DESCRIPTION);
     public void setDescription(String description) {
         set(PROPERTY_DESCRIPTION, description);
     public String getUserLevel() {
         return (String) get(PROPERTY_USERLEVEL);
     public void setUserLevel(String userLevel) {
         set(PROPERTY_USERLEVEL, userLevel);
     public Currency getCurrency() {
         return (Currency) get(PROPERTY_CURRENCY);
     public void setCurrency(Currency currency) {
         set(PROPERTY_CURRENCY, currency);
     public BigDecimal getApprovalAmount() {
         return (BigDecimal) get(PROPERTY_APPROVALAMOUNT);
     public void setApprovalAmount(BigDecimal approvalAmount) {
         set(PROPERTY_APPROVALAMOUNT, approvalAmount);
     public Tree getPrimaryTreeMenu() {
         return (Tree) get(PROPERTY_PRIMARYTREEMENU);
     public void setPrimaryTreeMenu(Tree primaryTreeMenu) {
         set(PROPERTY_PRIMARYTREEMENU, primaryTreeMenu);
     public Boolean isManual() {
         return (Boolean) get(PROPERTY_MANUAL);
     public void setManual(Boolean manual) {
         set(PROPERTY_MANUAL, manual);
     public Boolean isProcessNow() {
         return (Boolean) get(PROPERTY_PROCESSNOW);
     public void setProcessNow(Boolean processNow) {
         set(PROPERTY_PROCESSNOW, processNow);
     public Boolean isClientAdmin() {
         return (Boolean) get(PROPERTY_CLIENTADMIN);
     public void setClientAdmin(Boolean clientAdmin) {
         set(PROPERTY_CLIENTADMIN, clientAdmin);
     public Boolean isAdvanced() {
         return (Boolean) get(PROPERTY_ADVANCED);
     public void setAdvanced(Boolean advanced) {
         set(PROPERTY_ADVANCED, advanced);
     public Boolean isRestrictbackend() {
         return (Boolean) get(PROPERTY_ISRESTRICTBACKEND);
     public void setRestrictbackend(Boolean isrestrictbackend) {
         set(PROPERTY_ISRESTRICTBACKEND, isrestrictbackend);
     public Boolean isForPortalUsers() {
         return (Boolean) get(PROPERTY_FORPORTALUSERS);
     public void setForPortalUsers(Boolean forPortalUsers) {
         set(PROPERTY_FORPORTALUSERS, forPortalUsers);
     public Boolean isPortalAdmin() {
         return (Boolean) get(PROPERTY_PORTALADMIN);
     public void setPortalAdmin(Boolean portalAdmin) {
         set(PROPERTY_PORTALADMIN, portalAdmin);
     public Boolean isWebServiceEnabled() {
         return (Boolean) get(PROPERTY_ISWEBSERVICEENABLED);
     public void setWebServiceEnabled(Boolean isWebServiceEnabled) {
         set(PROPERTY_ISWEBSERVICEENABLED, isWebServiceEnabled);
     public Boolean isTemplate() {
         return (Boolean) get(PROPERTY_TEMPLATE);
     public void setTemplate(Boolean template) {
         set(PROPERTY_TEMPLATE, template);
     public Boolean isRecalculatePermissions() {
         return (Boolean) get(PROPERTY_RECALCULATEPERMISSIONS);
     public void setRecalculatePermissions(Boolean recalculatePermissions) {
         set(PROPERTY_RECALCULATEPERMISSIONS, recalculatePermissions);
     public List<AlertRecipient> getADAlertRecipientList() {
       return (List<AlertRecipient>) get(PROPERTY_ADALERTRECIPIENTLIST);
     public void setADAlertRecipientList(List<AlertRecipient> aDAlertRecipientList) {
         set(PROPERTY_ADALERTRECIPIENTLIST, aDAlertRecipientList);
     public List<FormAccess> getADFormAccessList() {
       return (List<FormAccess>) get(PROPERTY_ADFORMACCESSLIST);
     public void setADFormAccessList(List<FormAccess> aDFormAccessList) {
         set(PROPERTY_ADFORMACCESSLIST, aDFormAccessList);
     public List<Preference> getADPreferenceVisibleAtRoleList() {
     public void setADPreferenceVisibleAtRoleList(List<Preference> aDPreferenceVisibleAtRoleList) {
     public List<ProcessAccess> getADProcessAccessList() {
       return (List<ProcessAccess>) get(PROPERTY_ADPROCESSACCESSLIST);
     public void setADProcessAccessList(List<ProcessAccess> aDProcessAccessList) {
         set(PROPERTY_ADPROCESSACCESSLIST, aDProcessAccessList);
     public List<RoleInheritance> getADRoleInheritanceInheritFromList() {
     public void setADRoleInheritanceInheritFromList(List<RoleInheritance> aDRoleInheritanceInheritFromList) {
     public List<RoleInheritance> getADRoleInheritanceList() {
       return (List<RoleInheritance>) get(PROPERTY_ADROLEINHERITANCELIST);
     public void setADRoleInheritanceList(List<RoleInheritance> aDRoleInheritanceList) {
         set(PROPERTY_ADROLEINHERITANCELIST, aDRoleInheritanceList);
     public List<RoleOrganization> getADRoleOrganizationList() {
       return (List<RoleOrganization>) get(PROPERTY_ADROLEORGANIZATIONLIST);
     public void setADRoleOrganizationList(List<RoleOrganization> aDRoleOrganizationList) {
         set(PROPERTY_ADROLEORGANIZATIONLIST, aDRoleOrganizationList);
     public List<TableAccess> getADTableAccessList() {
       return (List<TableAccess>) get(PROPERTY_ADTABLEACCESSLIST);
     public void setADTableAccessList(List<TableAccess> aDTableAccessList) {
         set(PROPERTY_ADTABLEACCESSLIST, aDTableAccessList);
     public List<UserRoles> getADUserRolesList() {
       return (List<UserRoles>) get(PROPERTY_ADUSERROLESLIST);
     public void setADUserRolesList(List<UserRoles> aDUserRolesList) {
         set(PROPERTY_ADUSERROLESLIST, aDUserRolesList);
     public List<WindowAccess> getADWindowAccessList() {
       return (List<WindowAccess>) get(PROPERTY_ADWINDOWACCESSLIST);
     public void setADWindowAccessList(List<WindowAccess> aDWindowAccessList) {
         set(PROPERTY_ADWINDOWACCESSLIST, aDWindowAccessList);
     public List<WidgetClassAccess> getOBKMOWidgetClassAccessList() {
       return (List<WidgetClassAccess>) get(PROPERTY_OBKMOWIDGETCLASSACCESSLIST);
     public void setOBKMOWidgetClassAccessList(List<WidgetClassAccess> oBKMOWidgetClassAccessList) {
     public List<org.openbravo.client.application.ProcessAccess> getOBUIAPPProcessAccessList() {
       return (List<org.openbravo.client.application.ProcessAccess>) get(PROPERTY_OBUIAPPPROCESSACCESSLIST);
     public void setOBUIAPPProcessAccessList(List<org.openbravo.client.application.ProcessAccess> oBUIAPPProcessAccessList) {
     public List<ViewRoleAccess> getObuiappViewRoleAccessList() {
       return (List<ViewRoleAccess>) get(PROPERTY_OBUIAPPVIEWROLEACCESSLIST);
     public void setObuiappViewRoleAccessList(List<ViewRoleAccess> obuiappViewRoleAccessList) {
         set(PROPERTY_OBUIAPPVIEWROLEACCESSLIST, obuiappViewRoleAccessList);

Retrieved from ""

This page has been accessed 1,665 times. This page was last modified on 24 June 2019, at 15:58. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.