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/ShippingFreightCategory

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


ShippingFreightCategory

Freight Categories are used to calculate the Freight for the Shipper selected

To the database table (M_FreightCategory) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* M_FreightCategory_ID Mandatory
Max Length: 32
java.lang.String Freight Categories are used to calculate the Freight for the Shipper selected
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.
searchKey Value Mandatory
Max Length: 40
java.lang.String 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.

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.
helpComment Help Max Length: 2000
java.lang.String The Help field contains a hint, comment or help about the use of this item.
freightUOM Freight_Unit Max Length: 60
java.lang.String It is the unit how the quantity is given.
roundLine Line_Round Max Length: 60
java.lang.String How units are rounded for each of the in-out lines.
roundTotal Total_Round Max Length: 60
java.lang.String How units are rounded for the whole in-out.


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.shipping;
 
 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 ShippingFreightCategory (stored in table M_FreightCategory).
  * <br>
  * Help: {@literal Freight Categories are used to calculate the Freight for the Shipper selected}
  * <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 FreightCategory extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "M_FreightCategory";
     public static final String ENTITY_NAME = "ShippingFreightCategory";
 
     /**
      * Property id stored in column M_FreightCategory_ID in table M_FreightCategory<br>
      * Help: {@literal Freight Categories are used to calculate the Freight for the Shipper selected}
      * 
      */
     public static final String PROPERTY_ID = "id";
 
     /**
      * Property client stored in column AD_Client_ID in table M_FreightCategory 
      * @see ClientEnabled 
      * 
      */
     public static final String PROPERTY_CLIENT = "client";
 
     /**
      * Property organization stored in column AD_Org_ID in table M_FreightCategory 
      * @see OrganizationEnabled 
      * 
      */
     public static final String PROPERTY_ORGANIZATION = "organization";
 
     /**
      * Property active stored in column IsActive in table M_FreightCategory 
      * @see ActiveEnabled 
      * 
      */
     public static final String PROPERTY_ACTIVE = "active";
 
     /**
      * Property creationDate stored in column Created in table M_FreightCategory 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATIONDATE = "creationDate";
 
     /**
      * Property createdBy stored in column CreatedBy in table M_FreightCategory 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATEDBY = "createdBy";
 
     /**
      * Property updated stored in column Updated in table M_FreightCategory 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATED = "updated";
 
     /**
      * Property updatedBy stored in column UpdatedBy in table M_FreightCategory 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
 
     /**
      * Property searchKey stored in column Value in table M_FreightCategory<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 M_FreightCategory 
      * 
      */
     public static final String PROPERTY_NAME = "name";
 
     /**
      * Property description stored in column Description in table M_FreightCategory<br>
      * Help: {@literal A description is limited to 255 characters.}
      * 
      */
     public static final String PROPERTY_DESCRIPTION = "description";
 
     /**
      * Property helpComment stored in column Help in table M_FreightCategory<br>
      * Help: {@literal The Help field contains a hint, comment or help about the use of this item.}
      * 
      */
     public static final String PROPERTY_HELPCOMMENT = "helpComment";
 
     /**
      * Property freightUOM stored in column Freight_Unit in table M_FreightCategory<br>
      * Help: {@literal It is the unit how the quantity is given.}
      * 
      */
     public static final String PROPERTY_FREIGHTUOM = "freightUOM";
 
     /**
      * Property roundLine stored in column Line_Round in table M_FreightCategory<br>
      * Help: {@literal How units are rounded for each of the in-out lines.}
      * 
      */
     public static final String PROPERTY_ROUNDLINE = "roundLine";
 
     /**
      * Property roundTotal stored in column Total_Round in table M_FreightCategory<br>
      * Help: {@literal How units are rounded for the whole in-out.}
      * 
      */
     public static final String PROPERTY_ROUNDTOTAL = "roundTotal";
 
 
     public FreightCategory() {
         setDefaultValue(PROPERTY_ACTIVE, true);
     }
 
     @Override
     public String getEntityName() {
         return ENTITY_NAME;
     }
 
     /**
      * @see FreightCategory#PROPERTY_ID
      * 
      */
     public String getId() {
         return (String) get(PROPERTY_ID);
     }
     /**
      * @see FreightCategory#PROPERTY_ID
      * 
      */
     public void setId(String id) {
         set(PROPERTY_ID, id);
     }
 
     /**
      * @see FreightCategory#PROPERTY_CLIENT
      * 
      */
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     }
     /**
      * @see FreightCategory#PROPERTY_CLIENT
      * 
      */
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     }
 
     /**
      * @see FreightCategory#PROPERTY_ORGANIZATION
      * 
      */
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     }
     /**
      * @see FreightCategory#PROPERTY_ORGANIZATION
      * 
      */
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     }
 
     /**
      * @see FreightCategory#PROPERTY_ACTIVE
      * 
      */
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     }
     /**
      * @see FreightCategory#PROPERTY_ACTIVE
      * 
      */
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     }
 
     /**
      * @see FreightCategory#PROPERTY_CREATIONDATE
      * 
      */
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     }
     /**
      * @see FreightCategory#PROPERTY_CREATIONDATE
      * 
      */
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     }
 
     /**
      * @see FreightCategory#PROPERTY_CREATEDBY
      * 
      */
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     }
     /**
      * @see FreightCategory#PROPERTY_CREATEDBY
      * 
      */
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     }
 
     /**
      * @see FreightCategory#PROPERTY_UPDATED
      * 
      */
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     }
     /**
      * @see FreightCategory#PROPERTY_UPDATED
      * 
      */
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     }
 
     /**
      * @see FreightCategory#PROPERTY_UPDATEDBY
      * 
      */
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
     /**
      * @see FreightCategory#PROPERTY_UPDATEDBY
      * 
      */
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     /**
      * @see FreightCategory#PROPERTY_SEARCHKEY
      * 
      */
     public String getSearchKey() {
         return (String) get(PROPERTY_SEARCHKEY);
     }
     /**
      * @see FreightCategory#PROPERTY_SEARCHKEY
      * 
      */
     public void setSearchKey(String searchKey) {
         set(PROPERTY_SEARCHKEY, searchKey);
     }
 
     /**
      * @see FreightCategory#PROPERTY_NAME
      * 
      */
     public String getName() {
         return (String) get(PROPERTY_NAME);
     }
     /**
      * @see FreightCategory#PROPERTY_NAME
      * 
      */
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     }
 
     /**
      * @see FreightCategory#PROPERTY_DESCRIPTION
      * 
      */
     public String getDescription() {
         return (String) get(PROPERTY_DESCRIPTION);
     }
     /**
      * @see FreightCategory#PROPERTY_DESCRIPTION
      * 
      */
     public void setDescription(String description) {
         set(PROPERTY_DESCRIPTION, description);
     }
 
     /**
      * @see FreightCategory#PROPERTY_HELPCOMMENT
      * 
      */
     public String getHelpComment() {
         return (String) get(PROPERTY_HELPCOMMENT);
     }
     /**
      * @see FreightCategory#PROPERTY_HELPCOMMENT
      * 
      */
     public void setHelpComment(String helpComment) {
         set(PROPERTY_HELPCOMMENT, helpComment);
     }
 
     /**
      * @see FreightCategory#PROPERTY_FREIGHTUOM
      * 
      */
     public String getFreightUOM() {
         return (String) get(PROPERTY_FREIGHTUOM);
     }
     /**
      * @see FreightCategory#PROPERTY_FREIGHTUOM
      * 
      */
     public void setFreightUOM(String freightUOM) {
         set(PROPERTY_FREIGHTUOM, freightUOM);
     }
 
     /**
      * @see FreightCategory#PROPERTY_ROUNDLINE
      * 
      */
     public String getRoundLine() {
         return (String) get(PROPERTY_ROUNDLINE);
     }
     /**
      * @see FreightCategory#PROPERTY_ROUNDLINE
      * 
      */
     public void setRoundLine(String roundLine) {
         set(PROPERTY_ROUNDLINE, roundLine);
     }
 
     /**
      * @see FreightCategory#PROPERTY_ROUNDTOTAL
      * 
      */
     public String getRoundTotal() {
         return (String) get(PROPERTY_ROUNDTOTAL);
     }
     /**
      * @see FreightCategory#PROPERTY_ROUNDTOTAL
      * 
      */
     public void setRoundTotal(String roundTotal) {
         set(PROPERTY_ROUNDTOTAL, roundTotal);
     }
 
 }

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

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