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

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

Search

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

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#ADAlertRecipient


ADAlertRecipient

This table contains the recipients of the alert, they can be defined as individual users or as roles.

To the database table (AD_AlertRecipient) of this entity.

Properties

Note:

Property Column Constraints Type Description
userContact# AD_User_ID ADUser 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.
id* AD_Alertrecipient_ID Mandatory
Max Length: 32
java.lang.String
alertRule# AD_AlertRule_ID ADAlertRule Definition of the alert element.
role# AD_Role_ID Mandatory
ADRole The Role determines security and access a user who has this Role will have in the System.
sendEMail Sendemail java.lang.Boolean Send emails with document attached (e.g. Invoice, Delivery Note, etc.)
inheritedFrom Inherited_From ADRole The role from which a permission has been inherited. If a permission has this field set it means that this is an inherited permission, an therefore that the role owner of the permission is able to access it because it inherits from the role defined in this field.


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-2019 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.model.ad.alert;
 
 import java.util.Date;
 
 import org.openbravo.base.structure.ActiveEnabled;
 import org.openbravo.base.structure.BaseOBObject;
 import org.openbravo.base.structure.ClientEnabled;
 import org.openbravo.base.structure.InheritedAccessEnabled;
 import org.openbravo.base.structure.OrganizationEnabled;
 import org.openbravo.base.structure.Traceable;
 import org.openbravo.model.ad.access.Role;
 import org.openbravo.model.ad.access.User;
 import org.openbravo.model.ad.system.Client;
 import org.openbravo.model.common.enterprise.Organization;
 /**
  * Entity class for entity ADAlertRecipient (stored in table AD_AlertRecipient).
  * <br>
  * Help: {@literal This table contains the recipients of the alert, they can be defined as individual users
      *       or as roles.}
  * <br>
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class AlertRecipient extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled, InheritedAccessEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "AD_AlertRecipient";
     public static final String ENTITY_NAME = "ADAlertRecipient";
 
     /**
      * Property userContact stored in column AD_User_ID in table AD_AlertRecipient<br>
      * Help: {@literal The User identifies a unique user in the system. This could be an internal user or a
      *       business partner contact}
      * 
      */
     public static final String PROPERTY_USERCONTACT = "userContact";
 
     /**
      * Property client stored in column AD_Client_ID in table AD_AlertRecipient 
      * @see ClientEnabled 
      * 
      */
     public static final String PROPERTY_CLIENT = "client";
 
     /**
      * Property organization stored in column AD_Org_ID in table AD_AlertRecipient 
      * @see OrganizationEnabled 
      * 
      */
     public static final String PROPERTY_ORGANIZATION = "organization";
 
     /**
      * Property active stored in column IsActive in table AD_AlertRecipient 
      * @see ActiveEnabled 
      * 
      */
     public static final String PROPERTY_ACTIVE = "active";
 
     /**
      * Property creationDate stored in column Created in table AD_AlertRecipient 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATIONDATE = "creationDate";
 
     /**
      * Property createdBy stored in column Createdby in table AD_AlertRecipient 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATEDBY = "createdBy";
 
     /**
      * Property updated stored in column Updated in table AD_AlertRecipient 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATED = "updated";
 
     /**
      * Property updatedBy stored in column Updatedby in table AD_AlertRecipient 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
 
     /**
      * Property id stored in column AD_Alertrecipient_ID in table AD_AlertRecipient 
      * 
      */
     public static final String PROPERTY_ID = "id";
 
     /**
      * Property alertRule stored in column AD_AlertRule_ID in table AD_AlertRecipient<br>
      * Help: {@literal Definition of the alert element.}
      * 
      */
     public static final String PROPERTY_ALERTRULE = "alertRule";
 
     /**
      * Property role stored in column AD_Role_ID in table AD_AlertRecipient<br>
      * Help: {@literal The Role determines security and access a user who has this Role will have in the System.}
      * 
      */
     public static final String PROPERTY_ROLE = "role";
 
     /**
      * Property sendEMail stored in column Sendemail in table AD_AlertRecipient<br>
      * Help: {@literal Send emails with document attached (e.g. Invoice, Delivery Note, etc.)}
      * 
      */
     public static final String PROPERTY_SENDEMAIL = "sendEMail";
 
     /**
      * Property inheritedFrom stored in column Inherited_From in table AD_AlertRecipient<br>
      * Help: {@literal The role from which a permission has been inherited. If a permission has this field set it
      *       means that this is an inherited permission, an therefore that the role owner of the permission is
      *       able to access it because it inherits from the role defined in this field.}
      * 
      */
     public static final String PROPERTY_INHERITEDFROM = "inheritedFrom";
 
 
     public AlertRecipient() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_CREATIONDATE, new Date());
         setDefaultValue(PROPERTY_UPDATED, new Date());
         setDefaultValue(PROPERTY_SENDEMAIL, false);
     }
 
     @Override
     public String getEntityName() {
         return ENTITY_NAME;
     }
 
     /**
      * @see AlertRecipient#PROPERTY_USERCONTACT
      * 
      */
     public User getUserContact() {
         return (User) get(PROPERTY_USERCONTACT);
     }
     /**
      * @see AlertRecipient#PROPERTY_USERCONTACT
      * 
      */
     public void setUserContact(User userContact) {
         set(PROPERTY_USERCONTACT, userContact);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_CLIENT
      * 
      */
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     }
     /**
      * @see AlertRecipient#PROPERTY_CLIENT
      * 
      */
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_ORGANIZATION
      * 
      */
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     }
     /**
      * @see AlertRecipient#PROPERTY_ORGANIZATION
      * 
      */
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_ACTIVE
      * 
      */
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     }
     /**
      * @see AlertRecipient#PROPERTY_ACTIVE
      * 
      */
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_CREATIONDATE
      * 
      */
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     }
     /**
      * @see AlertRecipient#PROPERTY_CREATIONDATE
      * 
      */
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_CREATEDBY
      * 
      */
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     }
     /**
      * @see AlertRecipient#PROPERTY_CREATEDBY
      * 
      */
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_UPDATED
      * 
      */
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     }
     /**
      * @see AlertRecipient#PROPERTY_UPDATED
      * 
      */
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_UPDATEDBY
      * 
      */
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
     /**
      * @see AlertRecipient#PROPERTY_UPDATEDBY
      * 
      */
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_ID
      * 
      */
     public String getId() {
         return (String) get(PROPERTY_ID);
     }
     /**
      * @see AlertRecipient#PROPERTY_ID
      * 
      */
     public void setId(String id) {
         set(PROPERTY_ID, id);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_ALERTRULE
      * 
      */
     public AlertRule getAlertRule() {
         return (AlertRule) get(PROPERTY_ALERTRULE);
     }
     /**
      * @see AlertRecipient#PROPERTY_ALERTRULE
      * 
      */
     public void setAlertRule(AlertRule alertRule) {
         set(PROPERTY_ALERTRULE, alertRule);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_ROLE
      * 
      */
     public Role getRole() {
         return (Role) get(PROPERTY_ROLE);
     }
     /**
      * @see AlertRecipient#PROPERTY_ROLE
      * 
      */
     public void setRole(Role role) {
         set(PROPERTY_ROLE, role);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_SENDEMAIL
      * 
      */
     public Boolean isSendEMail() {
         return (Boolean) get(PROPERTY_SENDEMAIL);
     }
     /**
      * @see AlertRecipient#PROPERTY_SENDEMAIL
      * 
      */
     public void setSendEMail(Boolean sendEMail) {
         set(PROPERTY_SENDEMAIL, sendEMail);
     }
 
     /**
      * @see AlertRecipient#PROPERTY_INHERITEDFROM
      * 
      */
     public Role getInheritedFrom() {
         return (Role) get(PROPERTY_INHERITEDFROM);
     }
     /**
      * @see AlertRecipient#PROPERTY_INHERITEDFROM
      * 
      */
     public void setInheritedFrom(Role inheritedFrom) {
         set(PROPERTY_INHERITEDFROM, inheritedFrom);
     }
 
 }

Retrieved from "http://wiki.openbravo.com/wiki/ERP/3.0/Developers_Guide/Reference/Entity_Model/ADAlertRecipient"

This page has been accessed 1,282 times. This page was last modified on 2 December 2019, at 01:48. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.