View source | Discuss this page | Page history | Printable version   

ERP/2.50/Developers Guide/Reference/Entity Model/ADAlert

ADAlert

This table stores a line per each of the raised alerts.

To the database table (AD_Alert) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id* AD_Alert_ID Mandatory
Max Length: 32
java.lang.String An alert that has been raised.
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.
description Description Max Length: 2000 java.lang.String A description is limited to 255 characters.
alertRule# AD_AlertRule_ID ADAlertRule Definition of the alert element.
role AD_Role_ID ADRole The Role determines security and access a user who has this Role will have in the System.
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
fixed Isfixed java.lang.Boolean Is fixed
warehouse M_Warehouse_ID Warehouse The Warehouse identifies a unique Warehouse where products are stored or Services are provided.
comments Note Max Length: 2000 java.lang.String The Note field allows for optional entry of user defined information regarding this record
recordID# Record_ID Max Length: 100 java.lang.String The Record ID is the internal unique identifier of a record
referenceSearchKey Referencekey_ID Mandatory
Max Length: 32
java.lang.String Reference Key identifies the record that raised the alert, in case that this record belongs to a table with only a key field this should be the value, otherwise it will be necessary to compose a value from the different keys of the table.

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.alert;
 
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.access.Role;
import org.openbravo.model.ad.access.User;
import org.openbravo.model.ad.system.Client;
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.Date;
 
/**
 * Entity class for entity ADAlert (stored in table AD_Alert).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class Alert extends BaseOBObject implements Traceable, ClientEnabled,
    OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "AD_Alert";
    public static final String ADAlert = "ADAlert";
    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_DESCRIPTION = "description";
    public static final String PROPERTY_ALERTRULE = "alertRule";
    public static final String PROPERTY_ROLE = "role";
    public static final String PROPERTY_USERCONTACT = "userContact";
    public static final String PROPERTY_FIXED = "fixed";
    public static final String PROPERTY_WAREHOUSE = "warehouse";
    public static final String PROPERTY_COMMENTS = "comments";
    public static final String PROPERTY_RECORDID = "recordID";
    public static final String PROPERTY_REFERENCESEARCHKEY =
        "referenceSearchKey";
 
    public Alert() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_CREATIONDATE, new Date());
        setDefaultValue(PROPERTY_UPDATED, new Date());
        setDefaultValue(PROPERTY_FIXED, false);
    }
 
    @Override
    public String getEntityName() {
        return ADAlert;
    }
 
    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 getDescription() {
        return (String) get(PROPERTY_DESCRIPTION);
    }
 
    public void setDescription(String description) {
        set(PROPERTY_DESCRIPTION, description);
    }
 
    public AlertRule getAlertRule() {
        return (AlertRule) get(PROPERTY_ALERTRULE);
    }
 
    public void setAlertRule(AlertRule alertRule) {
        set(PROPERTY_ALERTRULE, alertRule);
    }
 
    public Role getRole() {
        return (Role) get(PROPERTY_ROLE);
    }
 
    public void setRole(Role role) {
        set(PROPERTY_ROLE, role);
    }
 
    public User getUserContact() {
        return (User) get(PROPERTY_USERCONTACT);
    }
 
    public void setUserContact(User userContact) {
        set(PROPERTY_USERCONTACT, userContact);
    }
 
    public Boolean isFixed() {
        return (Boolean) get(PROPERTY_FIXED);
    }
 
    public void setFixed(Boolean fixed) {
        set(PROPERTY_FIXED, fixed);
    }
 
    public Warehouse getWarehouse() {
        return (Warehouse) get(PROPERTY_WAREHOUSE);
    }
 
    public void setWarehouse(Warehouse warehouse) {
        set(PROPERTY_WAREHOUSE, warehouse);
    }
 
    public String getComments() {
        return (String) get(PROPERTY_COMMENTS);
    }
 
    public void setComments(String comments) {
        set(PROPERTY_COMMENTS, comments);
    }
 
    public String getRecordID() {
        return (String) get(PROPERTY_RECORDID);
    }
 
    public void setRecordID(String recordID) {
        set(PROPERTY_RECORDID, recordID);
    }
 
    public String getReferenceSearchKey() {
        return (String) get(PROPERTY_REFERENCESEARCHKEY);
    }
 
    public void setReferenceSearchKey(String referenceSearchKey) {
        set(PROPERTY_REFERENCESEARCHKEY, referenceSearchKey);
    }
}

Retrieved from "http://wiki.openbravo.com/wiki/ERP/2.50/Developers_Guide/Reference/Entity_Model/ADAlert"

This page has been accessed 2,478 times. This page was last modified on 2 July 2011, at 21:27. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.