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/2.50/Developers Guide/Reference/Entity Model/DocumentType

DocumentType

The Document Definition Tab defines the processing parameters and controls for the document.

To the database table (C_DocType) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id* C_DocType_ID Mandatory
Max Length: 32
java.lang.String The Document Type determines document sequence and processing rules
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.
printText PrintName Mandatory
Max Length: 60
java.lang.String The Label to be printed indicates the name that will be printed on a document or correspondence. The max length is 2000 characters.
description Description Max Length: 255 java.lang.String A description is limited to 255 characters.
documentCategory DocBaseType Mandatory
Max Length: 60
java.lang.String The Document Base Type identifies the base or starting point for a document. Multiple document types may share a single document base type.
salesTransaction IsSOTrx Mandatory java.lang.Boolean The Sales Transaction checkbox indicates if this item is a Sales Transaction.
sOSubType DocSubTypeSO Max Length: 60 java.lang.String The SO Sub Type indicates the type of sales order this document refers to. This field only appears when the Document Base Type is Sales Order. The selection made here will determine which documents will be generated when an order is processed and which documents must be generated manually or in batches.
The following outlines this process.
SO Sub Type of Standard Order will generate just the Order document when the order is processed.
The Delivery Note, Invoice and Receipt must be generated via other processes.
SO Sub Type of Warehouse Order will generate the Order and Delivery Note.
The Invoice and Receipt must be generated via other processes.
SO Sub Type of Credit Order will generate the Order, Delivery Note and Invoice.
The Reciept must be generated via other processes.
SO Sub Type of POS (Point of Sale) will generate all document
documentTypeForShipment C_DocTypeShipment_ID DocumentType The Document Type for Shipments indicates the document type that will be used when a shipment is generated from this sales document. This field will display only when the base document type is Sales Order.
documentTypeForInvoice C_DocTypeInvoice_ID DocumentType The Document Type for Invoice indicates the document type that will be used when an invoice is generated from this sales document. This field will display only when the base document type is Sales Order.
sequencedDocument IsDocNoControlled Mandatory java.lang.Boolean The Document Number Controlled checkbox indicates if this document type will have a sequence number.
documentSequence DocNoSequence_ID ADSequence The Document Sequence indicates the sequencing rule to use for this document type.
gLCategory GL_Category_ID Mandatory FinancialMgmtGLCategory The General Ledger Category is an optional, user defined method of grouping journal lines.
comments DocumentNote Max Length: 2000 java.lang.String The Document Note is used for recording any additional information regarding this product.
default IsDefault Mandatory java.lang.Boolean The Default Checkbox indicates if this record will be used as a default value.
numberOfCopies DocumentCopies Mandatory
Min: 0
java.lang.Long The Document Copies indicates the number of copies of each document that will be generated.
table AD_Table_ID ADTable The Table indicates the table in which a field or fields reside.
filterByOrganization Orgfiltered Mandatory java.lang.Boolean Filters by organization. This is used to calculate the document number by document type.
documentCancelled C_Doctype_Reversed_ID DocumentType
expense IsExpense Mandatory java.lang.Boolean Invoices in the Create AP Invoices process will be created preferably with a document type with this flag activated. This way invoices related to expenses will not appear in the Invoice Register Book.
reversal Isreversal Mandatory java.lang.Boolean The Reversal check box indicates if this is a reversal of a prior transaction.
documentTemplateList List of DocumentTemplate
documentTypeTrlList List of DocumentTypeTrl

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.common.enterprise;
 
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.datamodel.Table;
import org.openbravo.model.ad.system.Client;
import org.openbravo.model.ad.utility.Sequence;
import org.openbravo.model.financialmgmt.gl.GLCategory;
 
import java.lang.Boolean;
import java.lang.Long;
import java.lang.String;
 
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
 
/**
 * Entity class for entity DocumentType (stored in table C_DocType).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class DocumentType extends BaseOBObject implements Traceable,
    ClientEnabled, OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "C_DocType";
    public static final String DocumentType = "DocumentType";
    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_PRINTTEXT = "printText";
    public static final String PROPERTY_DESCRIPTION = "description";
    public static final String PROPERTY_DOCUMENTCATEGORY = "documentCategory";
    public static final String PROPERTY_SALESTRANSACTION = "salesTransaction";
    public static final String PROPERTY_SOSUBTYPE = "sOSubType";
    public static final String PROPERTY_DOCUMENTTYPEFORSHIPMENT =
        "documentTypeForShipment";
    public static final String PROPERTY_DOCUMENTTYPEFORINVOICE =
        "documentTypeForInvoice";
    public static final String PROPERTY_SEQUENCEDDOCUMENT = "sequencedDocument";
    public static final String PROPERTY_DOCUMENTSEQUENCE = "documentSequence";
    public static final String PROPERTY_GLCATEGORY = "gLCategory";
    public static final String PROPERTY_COMMENTS = "comments";
    public static final String PROPERTY_DEFAULT = "default";
    public static final String PROPERTY_NUMBEROFCOPIES = "numberOfCopies";
    public static final String PROPERTY_TABLE = "table";
    public static final String PROPERTY_FILTERBYORGANIZATION =
        "filterByOrganization";
    public static final String PROPERTY_DOCUMENTCANCELLED = "documentCancelled";
    public static final String PROPERTY_EXPENSE = "expense";
    public static final String PROPERTY_REVERSAL = "reversal";
    public static final String PROPERTY_DOCUMENTTEMPLATELIST =
        "documentTemplateList";
    public static final String PROPERTY_DOCUMENTTYPETRLLIST =
        "documentTypeTrlList";
 
    public DocumentType() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_SALESTRANSACTION, false);
        setDefaultValue(PROPERTY_SEQUENCEDDOCUMENT, true);
        setDefaultValue(PROPERTY_DEFAULT, false);
        setDefaultValue(PROPERTY_NUMBEROFCOPIES, (long) 1);
        setDefaultValue(PROPERTY_FILTERBYORGANIZATION, false);
        setDefaultValue(PROPERTY_EXPENSE, false);
        setDefaultValue(PROPERTY_REVERSAL, false);
        setDefaultValue(PROPERTY_DOCUMENTTEMPLATELIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_DOCUMENTTYPETRLLIST, new ArrayList<Object>());
    }
 
    @Override
    public String getEntityName() {
        return DocumentType;
    }
 
    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 getPrintText() {
        return (String) get(PROPERTY_PRINTTEXT);
    }
 
    public void setPrintText(String printText) {
        set(PROPERTY_PRINTTEXT, printText);
    }
 
    public String getDescription() {
        return (String) get(PROPERTY_DESCRIPTION);
    }
 
    public void setDescription(String description) {
        set(PROPERTY_DESCRIPTION, description);
    }
 
    public String getDocumentCategory() {
        return (String) get(PROPERTY_DOCUMENTCATEGORY);
    }
 
    public void setDocumentCategory(String documentCategory) {
        set(PROPERTY_DOCUMENTCATEGORY, documentCategory);
    }
 
    public Boolean isSalesTransaction() {
        return (Boolean) get(PROPERTY_SALESTRANSACTION);
    }
 
    public void setSalesTransaction(Boolean salesTransaction) {
        set(PROPERTY_SALESTRANSACTION, salesTransaction);
    }
 
    public String getSOSubType() {
        return (String) get(PROPERTY_SOSUBTYPE);
    }
 
    public void setSOSubType(String sOSubType) {
        set(PROPERTY_SOSUBTYPE, sOSubType);
    }
 
    public DocumentType getDocumentTypeForShipment() {
        return (DocumentType) get(PROPERTY_DOCUMENTTYPEFORSHIPMENT);
    }
 
    public void setDocumentTypeForShipment(DocumentType documentTypeForShipment) {
        set(PROPERTY_DOCUMENTTYPEFORSHIPMENT, documentTypeForShipment);
    }
 
    public DocumentType getDocumentTypeForInvoice() {
        return (DocumentType) get(PROPERTY_DOCUMENTTYPEFORINVOICE);
    }
 
    public void setDocumentTypeForInvoice(DocumentType documentTypeForInvoice) {
        set(PROPERTY_DOCUMENTTYPEFORINVOICE, documentTypeForInvoice);
    }
 
    public Boolean isSequencedDocument() {
        return (Boolean) get(PROPERTY_SEQUENCEDDOCUMENT);
    }
 
    public void setSequencedDocument(Boolean sequencedDocument) {
        set(PROPERTY_SEQUENCEDDOCUMENT, sequencedDocument);
    }
 
    public Sequence getDocumentSequence() {
        return (Sequence) get(PROPERTY_DOCUMENTSEQUENCE);
    }
 
    public void setDocumentSequence(Sequence documentSequence) {
        set(PROPERTY_DOCUMENTSEQUENCE, documentSequence);
    }
 
    public GLCategory getGLCategory() {
        return (GLCategory) get(PROPERTY_GLCATEGORY);
    }
 
    public void setGLCategory(GLCategory gLCategory) {
        set(PROPERTY_GLCATEGORY, gLCategory);
    }
 
    public String getComments() {
        return (String) get(PROPERTY_COMMENTS);
    }
 
    public void setComments(String comments) {
        set(PROPERTY_COMMENTS, comments);
    }
 
    public Boolean isDefault() {
        return (Boolean) get(PROPERTY_DEFAULT);
    }
 
    public void setDefault(Boolean deflt) {
        set(PROPERTY_DEFAULT, deflt);
    }
 
    public Long getNumberOfCopies() {
        return (Long) get(PROPERTY_NUMBEROFCOPIES);
    }
 
    public void setNumberOfCopies(Long numberOfCopies) {
        set(PROPERTY_NUMBEROFCOPIES, numberOfCopies);
    }
 
    public Table getTable() {
        return (Table) get(PROPERTY_TABLE);
    }
 
    public void setTable(Table table) {
        set(PROPERTY_TABLE, table);
    }
 
    public Boolean isFilterByOrganization() {
        return (Boolean) get(PROPERTY_FILTERBYORGANIZATION);
    }
 
    public void setFilterByOrganization(Boolean filterByOrganization) {
        set(PROPERTY_FILTERBYORGANIZATION, filterByOrganization);
    }
 
    public DocumentType getDocumentCancelled() {
        return (DocumentType) get(PROPERTY_DOCUMENTCANCELLED);
    }
 
    public void setDocumentCancelled(DocumentType documentCancelled) {
        set(PROPERTY_DOCUMENTCANCELLED, documentCancelled);
    }
 
    public Boolean isExpense() {
        return (Boolean) get(PROPERTY_EXPENSE);
    }
 
    public void setExpense(Boolean expense) {
        set(PROPERTY_EXPENSE, expense);
    }
 
    public Boolean isReversal() {
        return (Boolean) get(PROPERTY_REVERSAL);
    }
 
    public void setReversal(Boolean reversal) {
        set(PROPERTY_REVERSAL, reversal);
    }
 
    @SuppressWarnings("unchecked")
    public List<DocumentTemplate> getDocumentTemplateList() {
        return (List<DocumentTemplate>) get(PROPERTY_DOCUMENTTEMPLATELIST);
    }
 
    public void setDocumentTemplateList(
        List<DocumentTemplate> documentTemplateList) {
        set(PROPERTY_DOCUMENTTEMPLATELIST, documentTemplateList);
    }
 
    @SuppressWarnings("unchecked")
    public List<DocumentTypeTrl> getDocumentTypeTrlList() {
        return (List<DocumentTypeTrl>) get(PROPERTY_DOCUMENTTYPETRLLIST);
    }
 
    public void setDocumentTypeTrlList(
        List<DocumentTypeTrl> documentTypeTrlList) {
        set(PROPERTY_DOCUMENTTYPETRLLIST, documentTypeTrlList);
    }
}

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

This page has been accessed 2,109 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.