org.compiere.model.MRequisition

All Implemented Interfaces:: Serializable, Cloneable, Comparator<Object>, I_M_Requisition, I_Persistent, DocAction, Evaluatee

public class MRequisition extends X_M_Requisition implements DocAction

Requisition Model

Version:

$Id: MRequisition.java,v 1.2 2006/07/30 00:51:05 jjanke Exp $

Author:

Jorg Janke, victor.perez@e-evolution.com, e-Evolution http://www.e-evolution.com

FR [ 2520591 ] Support multiples calendar for Org, red1

FR [ 2214883 ] Remove SQL code and Replace for Query, Teo Sarca, www.arhipac.ro

FR [ 2744682 ] Requisition: improve error reporting

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_M_Requisition
DOCACTION_AD_Reference_ID, DOCACTION_Approve, DOCACTION_Close, DOCACTION_Complete, DOCACTION_Invalidate, DOCACTION_None, DOCACTION_Post, DOCACTION_Prepare, DOCACTION_Re_Activate, DOCACTION_Reject, DOCACTION_Reverse_Accrual, DOCACTION_Reverse_Correct, DOCACTION_Unlock, DOCACTION_Void, DOCACTION_WaitComplete, DOCSTATUS_AD_Reference_ID, DOCSTATUS_Approved, DOCSTATUS_Closed, DOCSTATUS_Completed, DOCSTATUS_Drafted, DOCSTATUS_InProgress, DOCSTATUS_Invalid, DOCSTATUS_NotApproved, DOCSTATUS_Reversed, DOCSTATUS_Unknown, DOCSTATUS_Voided, DOCSTATUS_WaitingConfirmation, DOCSTATUS_WaitingPayment, PRIORITYRULE_AD_Reference_ID, PRIORITYRULE_High, PRIORITYRULE_Low, PRIORITYRULE_Medium, PRIORITYRULE_Minor, PRIORITYRULE_Urgent

Fields inherited from class org.compiere.model.PO
ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.process.DocAction
ACTION_Approve, ACTION_Close, ACTION_Complete, ACTION_Invalidate, ACTION_None, ACTION_Post, ACTION_Prepare, ACTION_ReActivate, ACTION_Reject, ACTION_Reverse_Accrual, ACTION_Reverse_Correct, ACTION_Unlock, ACTION_Void, ACTION_WaitComplete, AD_REFERENCE_ID, DOC_COLUMNNAME_AD_User_ID, DOC_COLUMNNAME_C_Currency_ID, DOC_COLUMNNAME_C_DocType_ID, DOC_COLUMNNAME_C_DocTypeTarget_ID, DOC_COLUMNNAME_DateAcct, DOC_COLUMNNAME_DateTrx, DOC_COLUMNNAME_Description, DOC_COLUMNNAME_DocAction, DOC_COLUMNNAME_DocStatus, DOC_COLUMNNAME_DocumentNo, DOC_COLUMNNAME_IsApproved, DOC_COLUMNNAME_Processed, DOC_COLUMNNAME_Processing, DOC_COLUMNNAME_SalesRep_ID, STATUS_Approved, STATUS_Closed, STATUS_Completed, STATUS_Drafted, STATUS_InProgress, STATUS_Invalid, STATUS_NotApproved, STATUS_Reversed, STATUS_Unknown, STATUS_Voided, STATUS_WaitingConfirmation, STATUS_WaitingPayment

Fields inherited from interface org.compiere.model.I_M_Requisition
accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_User_ID, COLUMNNAME_C_DocType_ID, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_DateDoc, COLUMNNAME_DateRequired, COLUMNNAME_Description, COLUMNNAME_DocAction, COLUMNNAME_DocStatus, COLUMNNAME_DocumentNo, COLUMNNAME_Help, COLUMNNAME_IsActive, COLUMNNAME_IsApproved, COLUMNNAME_M_PriceList_ID, COLUMNNAME_M_Requisition_ID, COLUMNNAME_M_Requisition_UU, COLUMNNAME_M_Warehouse_ID, COLUMNNAME_Posted, COLUMNNAME_PriorityRule, COLUMNNAME_Processed, COLUMNNAME_ProcessedOn, COLUMNNAME_Processing, COLUMNNAME_TotalLines, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name
Constructor Summary

Constructors

Constructor

Description

MRequisition(Properties ctx, int M_Requisition_ID, String trxName)

Standard Constructor

MRequisition(Properties ctx, String M_Requisition_UU, String trxName)

UUID based Constructor

MRequisition(Properties ctx, ResultSet rs, String trxName)

Load Constructor
Method Summary

Modifier and Type

Method

Description

boolean

approveIt()

Approve Document

protected boolean

beforeDelete()

Execute before Delete operations.
Default implementation is nop, to be implemented in sub-classes that needed it.

protected boolean

beforeSave(boolean newRecord)

Called before Save for Pre-Save Operation.
Default implementation is nop, to be implemented in sub-classes that needed it.

boolean

closeIt()

Close Document.

String

completeIt()

Complete Document

File

createPDF()

Create PDF

File

createPDF(File file)

Create PDF file

BigDecimal

getApprovalAmt()

Get Document Approval Amount

int

getC_Currency_ID()

Get Document Currency

int

getDoc_User_ID()

Get Document Owner

String

getDocumentInfo()

Get Document Info

MRequisitionLine[]

getLines()

Get Requisition Lines

String

getProcessMsg()

Get Process Message

String

getSummary()

Get Summary

String

getUserName()

Get User Name

boolean

invalidateIt()

Invalidate Document

boolean

isComplete()

Document Status is Complete, Closed or Reverse

String

prepareIt()

Prepare Document

boolean

processIt(String processAction)

Process document

boolean

reActivateIt()

Re-activate

boolean

rejectIt()

Reject Approval

boolean

reverseAccrualIt()

Reverse Accrual

boolean

reverseCorrectIt()

Reverse Correction

void

setM_PriceList_ID()

Set default PriceList

String

toString()

String Representation

boolean

unlockIt()

Unlock Document.

boolean

voidIt()

Void Document.

Methods inherited from class org.compiere.model.X_M_Requisition
get_AccessLevel, getAD_User, getAD_User_ID, getC_DocType, getC_DocType_ID, getDateDoc, getDateRequired, getDescription, getDocAction, getDocStatus, getDocumentNo, getHelp, getKeyNamePair, getM_PriceList, getM_PriceList_ID, getM_Requisition_ID, getM_Requisition_UU, getM_Warehouse, getM_Warehouse_ID, getPriorityRule, getProcessedOn, getTotalLines, initPO, isApproved, isPosted, isProcessed, isProcessing, setAD_User_ID, setC_DocType_ID, setDateDoc, setDateRequired, setDescription, setDocAction, setDocStatus, setDocumentNo, setHelp, setIsApproved, setM_PriceList_ID, setM_Requisition_ID, setM_Requisition_UU, setM_Warehouse_ID, setPosted, setPriorityRule, setProcessed, setProcessedOn, setProcessing, setTotalLines

Methods inherited from class org.compiere.model.PO
afterDelete, afterSave, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableAttribute, get_TableAttributeAsBoolean, get_TableAttributeAsInt, get_TableAttributes, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys, validForeignKeysEx

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.process.DocAction
get_ID, get_Logger, get_Table_ID, get_TrxName, getAD_Client_ID, getAD_Org_ID, getCtx, getDocAction, getDocStatus, getDocumentNo, save, saveEx, setDocStatus

Methods inherited from interface org.compiere.model.I_M_Requisition
getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent
save

Constructor Details
- MRequisition
  
  public MRequisition(Properties ctx, String M_Requisition_UU, String trxName)
  
  UUID based Constructor
  
  Parameters:
  
  ctx - Context
  
  M_Requisition_UU - UUID key
  
  trxName - Transaction
- MRequisition
  
  public MRequisition(Properties ctx, int M_Requisition_ID, String trxName)
  
  Standard Constructor
  
  Parameters:
  
  ctx - context
  
  M_Requisition_ID - id
- MRequisition
  
  public MRequisition(Properties ctx, ResultSet rs, String trxName)
  
  Load Constructor
  
  Parameters:
  
  ctx - context
  
  rs - result set
Method Details
- getLines
  
  public MRequisitionLine[] getLines()
  
  Get Requisition Lines
  
  Returns:
  
  array of requisition lines
- toString
  
  public String toString()
  
  String Representation
  
  Overrides:
  
  toString in class X_M_Requisition
  
  Returns:
  
  info
- getDocumentInfo
  
  public String getDocumentInfo()
  
  Get Document Info
  
  Specified by:
  
  getDocumentInfo in interface DocAction
  
  Returns:
  
  document info
- createPDF
  
  public File createPDF()
  
  Create PDF
  
  Specified by:
  
  createPDF in interface DocAction
  
  Returns:
  
  File or null
- createPDF
  
  public File createPDF(File file)
  
  Create PDF file
  
  Parameters:
  
  file - output file
  
  Returns:
  
  not implemented, always return null
- setM_PriceList_ID
  
  public void setM_PriceList_ID()
  
  Set default PriceList
- beforeSave
  
  protected boolean beforeSave(boolean newRecord)
  
  Description copied from class: PO
  
  Called before Save for Pre-Save Operation.
  Default implementation is nop, to be implemented in sub-classes that needed it.
  
  Overrides:
  
  beforeSave in class PO
  
  Parameters:
  
  newRecord - true if it is a new record
  
  Returns:
  
  true if record can be saved
- beforeDelete
  
  protected boolean beforeDelete()
  
  Description copied from class: PO
  
  Execute before Delete operations.
  Default implementation is nop, to be implemented in sub-classes that needed it.
  
  Overrides:
  
  beforeDelete in class PO
  
  Returns:
  
  true if record can be deleted
- processIt
  
  public boolean processIt(String processAction)
  
  Process document
  
  Specified by:
  
  processIt in interface DocAction
  
  Parameters:
  
  processAction - document action
  
  Returns:
  
  true if performed
- unlockIt
  
  public boolean unlockIt()
  
  Unlock Document.
  
  Specified by:
  
  unlockIt in interface DocAction
  
  Returns:
  
  true if success
- invalidateIt
  
  public boolean invalidateIt()
  
  Invalidate Document
  
  Specified by:
  
  invalidateIt in interface DocAction
  
  Returns:
  
  true if success
- prepareIt
  
  public String prepareIt()
  
  Prepare Document
  
  Specified by:
  
  prepareIt in interface DocAction
  
  Returns:
  
  new status (In Progress or Invalid)
- approveIt
  
  public boolean approveIt()
  
  Approve Document
  
  Specified by:
  
  approveIt in interface DocAction
  
  Returns:
  
  true if success
- rejectIt
  
  public boolean rejectIt()
  
  Reject Approval
  
  Specified by:
  
  rejectIt in interface DocAction
  
  Returns:
  
  true if success
- completeIt
  
  public String completeIt()
  
  Complete Document
  
  Specified by:
  
  completeIt in interface DocAction
  
  Returns:
  
  new status (Complete, In Progress, Invalid, Waiting ..)
- voidIt
  
  public boolean voidIt()
  
  Void Document. Same as Close.
  
  Specified by:
  
  voidIt in interface DocAction
  
  Returns:
  
  true if success
- closeIt
  
  public boolean closeIt()
  
  Close Document. Cancel not delivered Qunatities
  
  Specified by:
  
  closeIt in interface DocAction
  
  Returns:
  
  true if success
- reverseCorrectIt
  
  public boolean reverseCorrectIt()
  
  Reverse Correction
  
  Specified by:
  
  reverseCorrectIt in interface DocAction
  
  Returns:
  
  not implemented, always return false
- reverseAccrualIt
  
  public boolean reverseAccrualIt()
  
  Reverse Accrual
  
  Specified by:
  
  reverseAccrualIt in interface DocAction
  
  Returns:
  
  not implemented, always return false
- reActivateIt
  
  public boolean reActivateIt()
  
  Re-activate
  
  Specified by:
  
  reActivateIt in interface DocAction
  
  Returns:
  
  true if success
- getSummary
  
  public String getSummary()
  
  Get Summary
  
  Specified by:
  
  getSummary in interface DocAction
  
  Returns:
  
  Summary of Document
- getProcessMsg
  
  public String getProcessMsg()
  
  Get Process Message
  
  Specified by:
  
  getProcessMsg in interface DocAction
  
  Returns:
  
  clear text error message
- getDoc_User_ID
  
  public int getDoc_User_ID()
  
  Get Document Owner
  
  Specified by:
  
  getDoc_User_ID in interface DocAction
  
  Returns:
  
  AD_User_ID
- getC_Currency_ID
  
  public int getC_Currency_ID()
  
  Get Document Currency
  
  Specified by:
  
  getC_Currency_ID in interface DocAction
  
  Returns:
  
  C_Currency_ID
- getApprovalAmt
  
  public BigDecimal getApprovalAmt()
  
  Get Document Approval Amount
  
  Specified by:
  
  getApprovalAmt in interface DocAction
  
  Returns:
  
  amount
- getUserName
  
  public String getUserName()
  
  Get User Name
  
  Returns:
  
  user name
- isComplete
  
  public boolean isComplete()
  
  Document Status is Complete, Closed or Reverse
  
  Returns:
  
  true if CO, CL or RE

Class MRequisition

Field Summary

Fields inherited from class org.compiere.model.X_M_Requisition

Fields inherited from class org.compiere.model.PO

Fields inherited from interface org.compiere.process.DocAction

Fields inherited from interface org.compiere.model.I_M_Requisition

Constructor Summary

Method Summary

Methods inherited from class org.compiere.model.X_M_Requisition

Methods inherited from class org.compiere.model.PO

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Comparator

Methods inherited from interface org.compiere.process.DocAction

Methods inherited from interface org.compiere.model.I_M_Requisition

Methods inherited from interface org.compiere.model.I_Persistent

Constructor Details

MRequisition

MRequisition

MRequisition

Method Details

getLines

toString

getDocumentInfo

createPDF

createPDF

setM_PriceList_ID

beforeSave

beforeDelete

processIt

unlockIt

invalidateIt

prepareIt

approveIt

rejectIt

completeIt

voidIt

closeIt

reverseCorrectIt

reverseAccrualIt

reActivateIt

getSummary

getProcessMsg

getDoc_User_ID

getC_Currency_ID

getApprovalAmt

getUserName

isComplete