ERP/3.0/Developers Guide/Reference/Entity Model/ProcurementRequisition
ProcurementRequisition
This table contains the headers of products demand. In the header it can be set a preferred vendor and/or price list. The requisitions are owned by an user of the Openbravo instance and have different statuses, each of them allowing different actions.In this window users manage only his own requisitions.
To the database table (M_Requisition) 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.
Property | Column | Constraints | Type | Description |
id* | M_Requisition_ID | Mandatory Max Length: 32 | java.lang.String | The ID identifies a unique requisition |
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: 255 | java.lang.String | A description is limited to 255 characters. |
documentNo# | DocumentNo | Mandatory Max Length: 30 | java.lang.String | The document number is usually automatically generated by the system and determined by the document type of the document. If the document is not saved, the preliminary number is displayed in "<>". If the document type of your document has no automatic document sequence defined, the field will be empty when creating a new document. This is for documents which usually have an external number (like vendor invoice). If you leave the field empty, the system will generate a document number for you. The document sequence used for this fallback number is defined in the "Document Sequence" window with the name "DocumentNo_<TableName>", where TableName is the actual name of the table inside the database (e.g. C_Order). |
businessPartner | C_BPartner_ID | BusinessPartner | A Business Partner is anyone with whom you transact. This can include a customer, vendor, employee or any combination of these. | |
priceList | M_PriceList_ID | PricingPriceList |
Price Lists are used to determine the pricing, margin and cost of items purchased or sold. | |
currency | C_Currency_ID | Currency | Indicates the currency to be used when processing this document. | |
createPO | Createpo | Mandatory | java.lang.Boolean | Button to generate the corresponding purchase orders to fulfill the products demand. |
documentStatus | DocStatus | Mandatory Max Length: 60 | java.lang.String | The Document Status indicates the status of a document at this time. To change the status of a document, use one of the buttons usually located at the bottom of the document window. |
documentAction | DocAction | Mandatory Max Length: 60 | java.lang.String |
You find the current status in the Document Status field. The options are listed in a popup |
processed | Processed | Mandatory | java.lang.Boolean | The Processed checkbox indicates that a document has been processed. |
userContact | AD_User_ID | Mandatory | ADUser | The User identifies a unique user in the system. This could be an internal user or a business partner contact |
processNow | Processing | Mandatory | java.lang.Boolean | When this field is set as 'Y' a process is being performed on this record. |
procurementRequisitionLineList | ProcurementRequisitionLine |
|
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.procurement; import java.util.ArrayList; import java.util.Date; import java.util.List; 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.businesspartner.BusinessPartner; import org.openbravo.model.common.currency.Currency; import org.openbravo.model.common.enterprise.Organization; import org.openbravo.model.pricing.pricelist.PriceList; /** * Entity class for entity ProcurementRequisition (stored in table M_Requisition). * <br> * Help: {@literal This table contains the headers of products demand. In the header it can be set a * preferred vendor and/or price list. The requisitions are owned by an user of the Openbravo instance * and have different statuses, each of them allowing different actions.In this window users manage * only his own requisitions.} * <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 Requisition extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "M_Requisition"; public static final String ENTITY_NAME = "ProcurementRequisition"; /** * Property id stored in column M_Requisition_ID in table M_Requisition<br> * Help: {@literal The ID identifies a unique requisition} * */ public static final String PROPERTY_ID = "id"; /** * Property client stored in column AD_Client_ID in table M_Requisition * @see ClientEnabled * */ public static final String PROPERTY_CLIENT = "client"; /** * Property organization stored in column AD_Org_ID in table M_Requisition * @see OrganizationEnabled * */ public static final String PROPERTY_ORGANIZATION = "organization"; /** * Property active stored in column IsActive in table M_Requisition * @see ActiveEnabled * */ public static final String PROPERTY_ACTIVE = "active"; /** * Property creationDate stored in column Created in table M_Requisition * @see Traceable * */ public static final String PROPERTY_CREATIONDATE = "creationDate"; /** * Property createdBy stored in column Createdby in table M_Requisition * @see Traceable * */ public static final String PROPERTY_CREATEDBY = "createdBy"; /** * Property updated stored in column Updated in table M_Requisition * @see Traceable * */ public static final String PROPERTY_UPDATED = "updated"; /** * Property updatedBy stored in column Updatedby in table M_Requisition * @see Traceable * */ public static final String PROPERTY_UPDATEDBY = "updatedBy"; /** * Property description stored in column Description in table M_Requisition<br> * Help: {@literal A description is limited to 255 characters.} * */ public static final String PROPERTY_DESCRIPTION = "description"; /** * Property documentNo stored in column DocumentNo in table M_Requisition * */ public static final String PROPERTY_DOCUMENTNO = "documentNo"; /** * Property businessPartner stored in column C_BPartner_ID in table M_Requisition<br> * Help: {@literal A Business Partner is anyone with whom you transact. This can include a customer, vendor, * employee or any combination of these.} * */ public static final String PROPERTY_BUSINESSPARTNER = "businessPartner"; /** * Property priceList stored in column M_PriceList_ID in table M_Requisition<br> * Help: {@literal * Price Lists are used to determine the pricing, margin and cost of items purchased or * sold.} * */ public static final String PROPERTY_PRICELIST = "priceList"; /** * Property currency stored in column C_Currency_ID in table M_Requisition<br> * Help: {@literal Indicates the currency to be used when processing this document.} * */ public static final String PROPERTY_CURRENCY = "currency"; /** * Property createPO stored in column Createpo in table M_Requisition<br> * Help: {@literal Button to generate the corresponding purchase orders to fulfill the products demand.} * */ public static final String PROPERTY_CREATEPO = "createPO"; /** * Property documentStatus stored in column DocStatus in table M_Requisition<br> * Help: {@literal The Document Status indicates the status of a document at this time. To change the status * of a document, use one of the buttons usually located at the bottom of the document window.} * */ public static final String PROPERTY_DOCUMENTSTATUS = "documentStatus"; /** * Property documentAction stored in column DocAction in table M_Requisition<br> * Help: {@literal * You find the current status in the Document Status field. The options are listed in a * popup} * */ public static final String PROPERTY_DOCUMENTACTION = "documentAction"; /** * Property processed stored in column Processed in table M_Requisition<br> * Help: {@literal The Processed checkbox indicates that a document has been processed.} * */ public static final String PROPERTY_PROCESSED = "processed"; /** * Property userContact stored in column AD_User_ID in table M_Requisition<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 processNow stored in column Processing in table M_Requisition<br> * Help: {@literal When this field is set as 'Y' a process is being performed on this record.} * */ public static final String PROPERTY_PROCESSNOW = "processNow"; /** * Property procurementRequisitionLineList stored in table M_Requisition * */ public static final String PROPERTY_PROCUREMENTREQUISITIONLINELIST = "procurementRequisitionLineList"; public Requisition() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_CREATIONDATE, new Date()); setDefaultValue(PROPERTY_UPDATED, new Date()); setDefaultValue(PROPERTY_CREATEPO, false); setDefaultValue(PROPERTY_DOCUMENTSTATUS, "DR"); setDefaultValue(PROPERTY_DOCUMENTACTION, "CO"); setDefaultValue(PROPERTY_PROCESSED, false); setDefaultValue(PROPERTY_PROCESSNOW, false); setDefaultValue(PROPERTY_PROCUREMENTREQUISITIONLINELIST, new ArrayList<Object>()); } @Override public String getEntityName() { return ENTITY_NAME; } /** * @see Requisition#PROPERTY_ID * */ public String getId() { return (String) get(PROPERTY_ID); } /** * @see Requisition#PROPERTY_ID * */ public void setId(String id) { set(PROPERTY_ID, id); } /** * @see Requisition#PROPERTY_CLIENT * */ public Client getClient() { return (Client) get(PROPERTY_CLIENT); } /** * @see Requisition#PROPERTY_CLIENT * */ public void setClient(Client client) { set(PROPERTY_CLIENT, client); } /** * @see Requisition#PROPERTY_ORGANIZATION * */ public Organization getOrganization() { return (Organization) get(PROPERTY_ORGANIZATION); } /** * @see Requisition#PROPERTY_ORGANIZATION * */ public void setOrganization(Organization organization) { set(PROPERTY_ORGANIZATION, organization); } /** * @see Requisition#PROPERTY_ACTIVE * */ public Boolean isActive() { return (Boolean) get(PROPERTY_ACTIVE); } /** * @see Requisition#PROPERTY_ACTIVE * */ public void setActive(Boolean active) { set(PROPERTY_ACTIVE, active); } /** * @see Requisition#PROPERTY_CREATIONDATE * */ public Date getCreationDate() { return (Date) get(PROPERTY_CREATIONDATE); } /** * @see Requisition#PROPERTY_CREATIONDATE * */ public void setCreationDate(Date creationDate) { set(PROPERTY_CREATIONDATE, creationDate); } /** * @see Requisition#PROPERTY_CREATEDBY * */ public User getCreatedBy() { return (User) get(PROPERTY_CREATEDBY); } /** * @see Requisition#PROPERTY_CREATEDBY * */ public void setCreatedBy(User createdBy) { set(PROPERTY_CREATEDBY, createdBy); } /** * @see Requisition#PROPERTY_UPDATED * */ public Date getUpdated() { return (Date) get(PROPERTY_UPDATED); } /** * @see Requisition#PROPERTY_UPDATED * */ public void setUpdated(Date updated) { set(PROPERTY_UPDATED, updated); } /** * @see Requisition#PROPERTY_UPDATEDBY * */ public User getUpdatedBy() { return (User) get(PROPERTY_UPDATEDBY); } /** * @see Requisition#PROPERTY_UPDATEDBY * */ public void setUpdatedBy(User updatedBy) { set(PROPERTY_UPDATEDBY, updatedBy); } /** * @see Requisition#PROPERTY_DESCRIPTION * */ public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } /** * @see Requisition#PROPERTY_DESCRIPTION * */ public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } /** * @see Requisition#PROPERTY_DOCUMENTNO * */ public String getDocumentNo() { return (String) get(PROPERTY_DOCUMENTNO); } /** * @see Requisition#PROPERTY_DOCUMENTNO * */ public void setDocumentNo(String documentNo) { set(PROPERTY_DOCUMENTNO, documentNo); } /** * @see Requisition#PROPERTY_BUSINESSPARTNER * */ public BusinessPartner getBusinessPartner() { return (BusinessPartner) get(PROPERTY_BUSINESSPARTNER); } /** * @see Requisition#PROPERTY_BUSINESSPARTNER * */ public void setBusinessPartner(BusinessPartner businessPartner) { set(PROPERTY_BUSINESSPARTNER, businessPartner); } /** * @see Requisition#PROPERTY_PRICELIST * */ public PriceList getPriceList() { return (PriceList) get(PROPERTY_PRICELIST); } /** * @see Requisition#PROPERTY_PRICELIST * */ public void setPriceList(PriceList priceList) { set(PROPERTY_PRICELIST, priceList); } /** * @see Requisition#PROPERTY_CURRENCY * */ public Currency getCurrency() { return (Currency) get(PROPERTY_CURRENCY); } /** * @see Requisition#PROPERTY_CURRENCY * */ public void setCurrency(Currency currency) { set(PROPERTY_CURRENCY, currency); } /** * @see Requisition#PROPERTY_CREATEPO * */ public Boolean isCreatePO() { return (Boolean) get(PROPERTY_CREATEPO); } /** * @see Requisition#PROPERTY_CREATEPO * */ public void setCreatePO(Boolean createPO) { set(PROPERTY_CREATEPO, createPO); } /** * @see Requisition#PROPERTY_DOCUMENTSTATUS * */ public String getDocumentStatus() { return (String) get(PROPERTY_DOCUMENTSTATUS); } /** * @see Requisition#PROPERTY_DOCUMENTSTATUS * */ public void setDocumentStatus(String documentStatus) { set(PROPERTY_DOCUMENTSTATUS, documentStatus); } /** * @see Requisition#PROPERTY_DOCUMENTACTION * */ public String getDocumentAction() { return (String) get(PROPERTY_DOCUMENTACTION); } /** * @see Requisition#PROPERTY_DOCUMENTACTION * */ public void setDocumentAction(String documentAction) { set(PROPERTY_DOCUMENTACTION, documentAction); } /** * @see Requisition#PROPERTY_PROCESSED * */ public Boolean isProcessed() { return (Boolean) get(PROPERTY_PROCESSED); } /** * @see Requisition#PROPERTY_PROCESSED * */ public void setProcessed(Boolean processed) { set(PROPERTY_PROCESSED, processed); } /** * @see Requisition#PROPERTY_USERCONTACT * */ public User getUserContact() { return (User) get(PROPERTY_USERCONTACT); } /** * @see Requisition#PROPERTY_USERCONTACT * */ public void setUserContact(User userContact) { set(PROPERTY_USERCONTACT, userContact); } /** * @see Requisition#PROPERTY_PROCESSNOW * */ public Boolean isProcessNow() { return (Boolean) get(PROPERTY_PROCESSNOW); } /** * @see Requisition#PROPERTY_PROCESSNOW * */ public void setProcessNow(Boolean processNow) { set(PROPERTY_PROCESSNOW, processNow); } /** * Help: {@literal This table contains each product demand of a requisition. The demand is defined by a * product, the date when is needed to have and the quantity. It is also possible to define a preferred * vendor, price list and the correspondent prices. The demands are locked when are being used to * generate the purchase orders so there are not created duplicate purchase orders for the same * demand.}<br> * @see RequisitionLine * */ @SuppressWarnings("unchecked") public List<RequisitionLine> getProcurementRequisitionLineList() { return (List<RequisitionLine>) get(PROPERTY_PROCUREMENTREQUISITIONLINELIST); } /** * Help: {@literal This table contains each product demand of a requisition. The demand is defined by a * product, the date when is needed to have and the quantity. It is also possible to define a preferred * vendor, price list and the correspondent prices. The demands are locked when are being used to * generate the purchase orders so there are not created duplicate purchase orders for the same * demand.}<br> * @see RequisitionLine * */ public void setProcurementRequisitionLineList(List<RequisitionLine> procurementRequisitionLineList) { set(PROPERTY_PROCUREMENTREQUISITIONLINELIST, procurementRequisitionLineList); } }