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

Back to ERP/3.0/Developers_Guide/Reference/Entity_Model#MarketingCampaign

MarketingCampaign

The Marketing Campaign defines the parameters for a Campaign. These include a start and end date as well as the amount of any invoices that have been processed which reference this campaign. Please note that you will not be able to create new entities in this window if you have not default set for all mandatory values!

To the database table (C_Campaign) 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.

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-2020 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.model.marketing;
 
 import java.math.BigDecimal;
 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.OrganizationEnabled;
 import org.openbravo.base.structure.Traceable;
 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 MarketingCampaign (stored in table C_Campaign).
  * <br>
  * Help: {@literal The Marketing Campaign defines the parameters for a Campaign.  These include a start and
      *       end date as well as the amount of any invoices that have been processed which reference this
      *       campaign.
      *       Please note that you will not be able to create new entities in this window if you have
      *       not default set for all mandatory values!}
  * <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 Campaign extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "C_Campaign";
     public static final String ENTITY_NAME = "MarketingCampaign";
 
     /**
      * Property id stored in column C_Campaign_ID in table C_Campaign<br>
      * Help: {@literal The Campaign defines a unique marketing program.  Projects can be associated with a pre
      *       defined Marketing Campaign.  You can then report based on a specific Campaign.}
      * 
      */
     public static final String PROPERTY_ID = "id";
 
     /**
      * Property client stored in column AD_Client_ID in table C_Campaign 
      * @see ClientEnabled 
      * 
      */
     public static final String PROPERTY_CLIENT = "client";
 
     /**
      * Property organization stored in column AD_Org_ID in table C_Campaign 
      * @see OrganizationEnabled 
      * 
      */
     public static final String PROPERTY_ORGANIZATION = "organization";
 
     /**
      * Property active stored in column IsActive in table C_Campaign 
      * @see ActiveEnabled 
      * 
      */
     public static final String PROPERTY_ACTIVE = "active";
 
     /**
      * Property creationDate stored in column Created in table C_Campaign 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATIONDATE = "creationDate";
 
     /**
      * Property createdBy stored in column CreatedBy in table C_Campaign 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATEDBY = "createdBy";
 
     /**
      * Property updated stored in column Updated in table C_Campaign 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATED = "updated";
 
     /**
      * Property updatedBy stored in column UpdatedBy in table C_Campaign 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
 
     /**
      * Property searchKey stored in column Value in table C_Campaign<br>
      * Help: {@literal A search key allows for a fast method of finding a particular record. If you leave the
      *       search key empty, the system automatically creates a numeric number originating from a document
      *       sequence defined in the  "Document Sequence" window. The sequence naming convention follows a rule
      *       "DocumentNo_TableName", where TableName is the actual name of the database table (e.g.
      *       C_Order).
      *       
      *       Usually, company's internal identifiers for various records (products, customers, etc)
      *       are stored here.}
      * 
      */
     public static final String PROPERTY_SEARCHKEY = "searchKey";
 
     /**
      * Property name stored in column Name in table C_Campaign 
      * 
      */
     public static final String PROPERTY_NAME = "name";
 
     /**
      * Property description stored in column Description in table C_Campaign<br>
      * Help: {@literal A description is limited to 255 characters.}
      * 
      */
     public static final String PROPERTY_DESCRIPTION = "description";
 
     /**
      * Property marketingChannel stored in column C_Channel_ID in table C_Campaign<br>
      * Help: {@literal Identifies a method of sales generation.}
      * 
      */
     public static final String PROPERTY_MARKETINGCHANNEL = "marketingChannel";
 
     /**
      * Property startingDate stored in column StartDate in table C_Campaign<br>
      * Help: {@literal A parameter stating when a specified request will begin.}
      * 
      */
     public static final String PROPERTY_STARTINGDATE = "startingDate";
 
     /**
      * Property endingDate stored in column EndDate in table C_Campaign<br>
      * Help: {@literal The End Date indicates the last date in this range.}
      * 
      */
     public static final String PROPERTY_ENDINGDATE = "endingDate";
 
     /**
      * Property costs stored in column Costs in table C_Campaign<br>
      * Help: {@literal The Costs indicates the cost of a campaign in an Organizations accounting currency.}
      * 
      */
     public static final String PROPERTY_COSTS = "costs";
 
     /**
      * Property summaryLevel stored in column Issummary in table C_Campaign<br>
      * Help: {@literal A summary entity represents a branch in a tree rather than an end-node. Summary entities
      *       are used for reporting and do not have own values.}
      * 
      */
     public static final String PROPERTY_SUMMARYLEVEL = "summaryLevel";
 
 
     public Campaign() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_SUMMARYLEVEL, false);
     }
 
     @Override
     public String getEntityName() {
         return ENTITY_NAME;
     }
 
     /**
      * @see Campaign#PROPERTY_ID
      * 
      */
     public String getId() {
         return (String) get(PROPERTY_ID);
     }
     /**
      * @see Campaign#PROPERTY_ID
      * 
      */
     public void setId(String id) {
         set(PROPERTY_ID, id);
     }
 
     /**
      * @see Campaign#PROPERTY_CLIENT
      * 
      */
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     }
     /**
      * @see Campaign#PROPERTY_CLIENT
      * 
      */
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     }
 
     /**
      * @see Campaign#PROPERTY_ORGANIZATION
      * 
      */
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     }
     /**
      * @see Campaign#PROPERTY_ORGANIZATION
      * 
      */
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     }
 
     /**
      * @see Campaign#PROPERTY_ACTIVE
      * 
      */
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     }
     /**
      * @see Campaign#PROPERTY_ACTIVE
      * 
      */
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     }
 
     /**
      * @see Campaign#PROPERTY_CREATIONDATE
      * 
      */
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     }
     /**
      * @see Campaign#PROPERTY_CREATIONDATE
      * 
      */
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     }
 
     /**
      * @see Campaign#PROPERTY_CREATEDBY
      * 
      */
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     }
     /**
      * @see Campaign#PROPERTY_CREATEDBY
      * 
      */
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     }
 
     /**
      * @see Campaign#PROPERTY_UPDATED
      * 
      */
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     }
     /**
      * @see Campaign#PROPERTY_UPDATED
      * 
      */
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     }
 
     /**
      * @see Campaign#PROPERTY_UPDATEDBY
      * 
      */
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
     /**
      * @see Campaign#PROPERTY_UPDATEDBY
      * 
      */
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     /**
      * @see Campaign#PROPERTY_SEARCHKEY
      * 
      */
     public String getSearchKey() {
         return (String) get(PROPERTY_SEARCHKEY);
     }
     /**
      * @see Campaign#PROPERTY_SEARCHKEY
      * 
      */
     public void setSearchKey(String searchKey) {
         set(PROPERTY_SEARCHKEY, searchKey);
     }
 
     /**
      * @see Campaign#PROPERTY_NAME
      * 
      */
     public String getName() {
         return (String) get(PROPERTY_NAME);
     }
     /**
      * @see Campaign#PROPERTY_NAME
      * 
      */
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     }
 
     /**
      * @see Campaign#PROPERTY_DESCRIPTION
      * 
      */
     public String getDescription() {
         return (String) get(PROPERTY_DESCRIPTION);
     }
     /**
      * @see Campaign#PROPERTY_DESCRIPTION
      * 
      */
     public void setDescription(String description) {
         set(PROPERTY_DESCRIPTION, description);
     }
 
     /**
      * @see Campaign#PROPERTY_MARKETINGCHANNEL
      * 
      */
     public Channel getMarketingChannel() {
         return (Channel) get(PROPERTY_MARKETINGCHANNEL);
     }
     /**
      * @see Campaign#PROPERTY_MARKETINGCHANNEL
      * 
      */
     public void setMarketingChannel(Channel marketingChannel) {
         set(PROPERTY_MARKETINGCHANNEL, marketingChannel);
     }
 
     /**
      * @see Campaign#PROPERTY_STARTINGDATE
      * 
      */
     public Date getStartingDate() {
         return (Date) get(PROPERTY_STARTINGDATE);
     }
     /**
      * @see Campaign#PROPERTY_STARTINGDATE
      * 
      */
     public void setStartingDate(Date startingDate) {
         set(PROPERTY_STARTINGDATE, startingDate);
     }
 
     /**
      * @see Campaign#PROPERTY_ENDINGDATE
      * 
      */
     public Date getEndingDate() {
         return (Date) get(PROPERTY_ENDINGDATE);
     }
     /**
      * @see Campaign#PROPERTY_ENDINGDATE
      * 
      */
     public void setEndingDate(Date endingDate) {
         set(PROPERTY_ENDINGDATE, endingDate);
     }
 
     /**
      * @see Campaign#PROPERTY_COSTS
      * 
      */
     public BigDecimal getCosts() {
         return (BigDecimal) get(PROPERTY_COSTS);
     }
     /**
      * @see Campaign#PROPERTY_COSTS
      * 
      */
     public void setCosts(BigDecimal costs) {
         set(PROPERTY_COSTS, costs);
     }
 
     /**
      * @see Campaign#PROPERTY_SUMMARYLEVEL
      * 
      */
     public Boolean isSummaryLevel() {
         return (Boolean) get(PROPERTY_SUMMARYLEVEL);
     }
     /**
      * @see Campaign#PROPERTY_SUMMARYLEVEL
      * 
      */
     public void setSummaryLevel(Boolean summaryLevel) {
         set(PROPERTY_SUMMARYLEVEL, summaryLevel);
     }
 
 }