ERP 2.50:Developers Guide/Reference/Entity Model/ADUser
ADUser
The User Tab defines the log in for Users who have access to the system. The User identifies a unique user in the system. This could be an internal user or a business partner contact
To the database table (AD_User) of this entity.
Properties
Note:
- Properties marked with a * are part of the Id of the Entity.
- Properties marked with a # are part of the Identifier of the Entity.
Property | Column | Constraints | Type | Description |
id* | AD_User_ID | Mandatory Max Length: 32 | java.lang.String | The User identifies a unique user in the system. This could be an internal user or a business partner contact |
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. |
updatedBy | UpdatedBy | Mandatory | ADUser | The Updated By field indicates the user who updated this record. |
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. |
description | Description | Max Length: 255 | java.lang.String | A description is limited to 255 characters. |
password | Password | Max Length: 40 | java.lang.String | The Password indicates the Password for this User Id. Passwords are required to identify authorized users. |
Max Length: 40 | java.lang.String | The Email Address is the Electronic Mail ID for this User and should be fully qualified (e.g. joe.smith@company.com). | ||
supervisor | Supervisor_ID | ADUser | The Supervisor indicates who will be used for forwarding and escalating issues for this user. | |
businessPartner | C_BPartner_ID | BusinessPartner | A Business Partner is anyone with whom you transact. This can include a customer, vendor, employee or any combination of these. | |
processNow | Processing | java.lang.Boolean | When this field is set as 'Y' a process is being performed on this record. | |
emailServerUsername | EmailUser | Max Length: 20 | java.lang.String | The user name in the mail system is usually the string before the @ of your email address. Required if the mail server requires authentification to send emails. |
emailServerPassword | EmailUserPW | Max Length: 40 | java.lang.String | Required if the mail server requires authentification to send emails. |
partnerAddress | C_BPartner_Location_ID | BusinessPartnerLocation | The Partner address indicates the location of a Business Partner | |
greeting | C_Greeting_ID | Greeting | The Greeting identifies the greeting to print on correspondence. | |
position | Title | Max Length: 40 | java.lang.String | The Title indicates the name that an entity is referred to as. |
comments | Comments | Max Length: 2000 | java.lang.String | The Comments field allows for free form entry of additional information. |
phone | Phone | Max Length: 40 | java.lang.String | The Phone field identifies a telephone number |
alternativePhone | Phone2 | Max Length: 40 | java.lang.String | The 2nd Phone field identifies an alternate telephone number. |
fax | Fax | Max Length: 40 | java.lang.String | The Fax identifies a facsimile number for this Business Partner or Location |
lastContactDate | LastContact | java.util.Date | The Last Contact indicates the date that this Business Partner Contact was last contacted. | |
lastContactResult | LastResult | Max Length: 255 | java.lang.String | The Last Result identifies the result of the last contact made. |
birthday | Birthday | java.util.Date | Birthday or Anniversary day | |
trxOrganization | AD_OrgTrx_ID | Organization | The organization which performs or initiates this transaction (for another organization). The owning Organization may not be the transaction organization in a service bureau environment, with centralized services, and inter-organization transactions. | |
firstName | Firstname | Max Length: 60 | java.lang.String | First Name of the contact |
lastName | Lastname | Max Length: 60 | java.lang.String | Last name of the contact |
username | UserName | Max Length: 60 | java.lang.String | Name that identifies the user in the System |
defaultClient | Default_Ad_Client_ID | ADClient | Client that user will use by default when is logged | |
defaultLanguage | Default_Ad_Language | ADLanguage | Default language of the user interface upon log in of the current user. | |
defaultOrganization | Default_Ad_Org_ID | Organization | Default organization that will be used when entering new transactions (eg. creating a new sales order). | |
defaultRole | Default_Ad_Role_ID | ADRole | Default role applied when this user logs in (only the ones applicable to the user are shown). | |
defaultWarehouse | Default_M_Warehouse_ID | Warehouse | Default warehouse that will be used within transactions that require warehouse movements. | |
locked | IsLocked | Mandatory | java.lang.Boolean | The user is locked and cannot log in the application. This field can be manually set or automatically if login.trial.user.lock property is configured in Openbravo.properties file and there has been that number of failed log in attempts. |
contactInterestList | List of ContactInterest | |||
aDUserRolesList | List of ADUserRoles |
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 http://www.openbravo.com/legal/license.html * 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-2010 Openbravo SLU * All Rights Reserved. * Contributor(s): ______________________________________. ************************************************************************ */ package org.openbravo.model.ad.access; 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.model.ad.system.Client; import org.openbravo.model.ad.system.Language; import org.openbravo.model.common.businesspartner.BusinessPartner; import org.openbravo.model.common.businesspartner.ContactInterest; import org.openbravo.model.common.businesspartner.Greeting; import org.openbravo.model.common.businesspartner.Location; import org.openbravo.model.common.enterprise.Organization; import org.openbravo.model.common.enterprise.Warehouse; import java.lang.Boolean; import java.lang.String; import java.util.ArrayList; import java.util.Date; import java.util.List; /** * Entity class for entity ADUser (stored in table AD_User). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class User extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "AD_User"; public static final String ADUser = "ADUser"; 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_UPDATEDBY = "updatedBy"; public static final String PROPERTY_NAME = "name"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_PASSWORD = "password"; public static final String PROPERTY_EMAIL = "email"; public static final String PROPERTY_SUPERVISOR = "supervisor"; public static final String PROPERTY_BUSINESSPARTNER = "businessPartner"; public static final String PROPERTY_PROCESSNOW = "processNow"; public static final String PROPERTY_EMAILSERVERUSERNAME = "emailServerUsername"; public static final String PROPERTY_EMAILSERVERPASSWORD = "emailServerPassword"; public static final String PROPERTY_PARTNERADDRESS = "partnerAddress"; public static final String PROPERTY_GREETING = "greeting"; public static final String PROPERTY_POSITION = "position"; public static final String PROPERTY_COMMENTS = "comments"; public static final String PROPERTY_PHONE = "phone"; public static final String PROPERTY_ALTERNATIVEPHONE = "alternativePhone"; public static final String PROPERTY_FAX = "fax"; public static final String PROPERTY_LASTCONTACTDATE = "lastContactDate"; public static final String PROPERTY_LASTCONTACTRESULT = "lastContactResult"; public static final String PROPERTY_BIRTHDAY = "birthday"; public static final String PROPERTY_TRXORGANIZATION = "trxOrganization"; public static final String PROPERTY_FIRSTNAME = "firstName"; public static final String PROPERTY_LASTNAME = "lastName"; public static final String PROPERTY_USERNAME = "username"; public static final String PROPERTY_DEFAULTCLIENT = "defaultClient"; public static final String PROPERTY_DEFAULTLANGUAGE = "defaultLanguage"; public static final String PROPERTY_DEFAULTORGANIZATION = "defaultOrganization"; public static final String PROPERTY_DEFAULTROLE = "defaultRole"; public static final String PROPERTY_DEFAULTWAREHOUSE = "defaultWarehouse"; public static final String PROPERTY_LOCKED = "locked"; public static final String PROPERTY_CONTACTINTERESTLIST = "contactInterestList"; public static final String PROPERTY_ADUSERROLESLIST = "aDUserRolesList"; public User() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_PROCESSNOW, false); setDefaultValue(PROPERTY_LOCKED, false); setDefaultValue(PROPERTY_CONTACTINTERESTLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_ADUSERROLESLIST, new ArrayList<Object>()); } @Override public String getEntityName() { return ADUser; } 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 User getUpdatedBy() { return (User) get(PROPERTY_UPDATEDBY); } public void setUpdatedBy(User updatedBy) { set(PROPERTY_UPDATEDBY, updatedBy); } public String getName() { return (String) get(PROPERTY_NAME); } public void setName(String name) { set(PROPERTY_NAME, name); } public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } public String getPassword() { return (String) get(PROPERTY_PASSWORD); } public void setPassword(String password) { set(PROPERTY_PASSWORD, password); } public String getEmail() { return (String) get(PROPERTY_EMAIL); } public void setEmail(String email) { set(PROPERTY_EMAIL, email); } public User getSupervisor() { return (User) get(PROPERTY_SUPERVISOR); } public void setSupervisor(User supervisor) { set(PROPERTY_SUPERVISOR, supervisor); } public BusinessPartner getBusinessPartner() { return (BusinessPartner) get(PROPERTY_BUSINESSPARTNER); } public void setBusinessPartner(BusinessPartner businessPartner) { set(PROPERTY_BUSINESSPARTNER, businessPartner); } public Boolean isProcessNow() { return (Boolean) get(PROPERTY_PROCESSNOW); } public void setProcessNow(Boolean processNow) { set(PROPERTY_PROCESSNOW, processNow); } public String getEmailServerUsername() { return (String) get(PROPERTY_EMAILSERVERUSERNAME); } public void setEmailServerUsername(String emailServerUsername) { set(PROPERTY_EMAILSERVERUSERNAME, emailServerUsername); } public String getEmailServerPassword() { return (String) get(PROPERTY_EMAILSERVERPASSWORD); } public void setEmailServerPassword(String emailServerPassword) { set(PROPERTY_EMAILSERVERPASSWORD, emailServerPassword); } public Location getPartnerAddress() { return (Location) get(PROPERTY_PARTNERADDRESS); } public void setPartnerAddress(Location partnerAddress) { set(PROPERTY_PARTNERADDRESS, partnerAddress); } public Greeting getGreeting() { return (Greeting) get(PROPERTY_GREETING); } public void setGreeting(Greeting greeting) { set(PROPERTY_GREETING, greeting); } public String getPosition() { return (String) get(PROPERTY_POSITION); } public void setPosition(String position) { set(PROPERTY_POSITION, position); } public String getComments() { return (String) get(PROPERTY_COMMENTS); } public void setComments(String comments) { set(PROPERTY_COMMENTS, comments); } public String getPhone() { return (String) get(PROPERTY_PHONE); } public void setPhone(String phone) { set(PROPERTY_PHONE, phone); } public String getAlternativePhone() { return (String) get(PROPERTY_ALTERNATIVEPHONE); } public void setAlternativePhone(String alternativePhone) { set(PROPERTY_ALTERNATIVEPHONE, alternativePhone); } public String getFax() { return (String) get(PROPERTY_FAX); } public void setFax(String fax) { set(PROPERTY_FAX, fax); } public Date getLastContactDate() { return (Date) get(PROPERTY_LASTCONTACTDATE); } public void setLastContactDate(Date lastContactDate) { set(PROPERTY_LASTCONTACTDATE, lastContactDate); } public String getLastContactResult() { return (String) get(PROPERTY_LASTCONTACTRESULT); } public void setLastContactResult(String lastContactResult) { set(PROPERTY_LASTCONTACTRESULT, lastContactResult); } public Date getBirthday() { return (Date) get(PROPERTY_BIRTHDAY); } public void setBirthday(Date birthday) { set(PROPERTY_BIRTHDAY, birthday); } public Organization getTrxOrganization() { return (Organization) get(PROPERTY_TRXORGANIZATION); } public void setTrxOrganization(Organization trxOrganization) { set(PROPERTY_TRXORGANIZATION, trxOrganization); } public String getFirstName() { return (String) get(PROPERTY_FIRSTNAME); } public void setFirstName(String firstName) { set(PROPERTY_FIRSTNAME, firstName); } public String getLastName() { return (String) get(PROPERTY_LASTNAME); } public void setLastName(String lastName) { set(PROPERTY_LASTNAME, lastName); } public String getUsername() { return (String) get(PROPERTY_USERNAME); } public void setUsername(String username) { set(PROPERTY_USERNAME, username); } public Client getDefaultClient() { return (Client) get(PROPERTY_DEFAULTCLIENT); } public void setDefaultClient(Client defaultClient) { set(PROPERTY_DEFAULTCLIENT, defaultClient); } public Language getDefaultLanguage() { return (Language) get(PROPERTY_DEFAULTLANGUAGE); } public void setDefaultLanguage(Language defaultLanguage) { set(PROPERTY_DEFAULTLANGUAGE, defaultLanguage); } public Organization getDefaultOrganization() { return (Organization) get(PROPERTY_DEFAULTORGANIZATION); } public void setDefaultOrganization(Organization defaultOrganization) { set(PROPERTY_DEFAULTORGANIZATION, defaultOrganization); } public Role getDefaultRole() { return (Role) get(PROPERTY_DEFAULTROLE); } public void setDefaultRole(Role defaultRole) { set(PROPERTY_DEFAULTROLE, defaultRole); } public Warehouse getDefaultWarehouse() { return (Warehouse) get(PROPERTY_DEFAULTWAREHOUSE); } public void setDefaultWarehouse(Warehouse defaultWarehouse) { set(PROPERTY_DEFAULTWAREHOUSE, defaultWarehouse); } public Boolean isLocked() { return (Boolean) get(PROPERTY_LOCKED); } public void setLocked(Boolean locked) { set(PROPERTY_LOCKED, locked); } @SuppressWarnings("unchecked") public List<ContactInterest> getContactInterestList() { return (List<ContactInterest>) get(PROPERTY_CONTACTINTERESTLIST); } public void setContactInterestList( List<ContactInterest> contactInterestList) { set(PROPERTY_CONTACTINTERESTLIST, contactInterestList); } @SuppressWarnings("unchecked") public List<UserRoles> getADUserRolesList() { return (List<UserRoles>) get(PROPERTY_ADUSERROLESLIST); } public void setADUserRolesList(List<UserRoles> aDUserRolesList) { set(PROPERTY_ADUSERROLESLIST, aDUserRolesList); } }