Package org.compiere.model
Class MInOutConfirm
java.lang.Object
org.compiere.model.PO
org.compiere.model.X_M_InOutConfirm
org.compiere.model.MInOutConfirm
- All Implemented Interfaces:
Serializable,Cloneable,Comparator<Object>,I_M_InOutConfirm,I_Persistent,DocAction,Evaluatee
Shipment Confirmation Model
- Version:
- $Id: MInOutConfirm.java,v 1.3 2006/07/30 00:51:03 jjanke Exp $
- Author:
- Jorg Janke, Teo Sarca, www.arhipac.ro
- BF [ 2800460 ] System generate Material Receipt with no lines https://sourceforge.net/p/adempiere/bugs/1928/, Teo Sarca, teo.sarca@gmail.com
- BF [ 2993853 ] Voiding/Reversing Receipt should void confirmations https://sourceforge.net/p/adempiere/bugs/2395/
- FR [ 2994115 ] Add C_DocType.IsPrepareSplitDoc flag https://sourceforge.net/p/adempiere/feature-requests/967/
- See Also:
-
Field Summary
Fields inherited from class org.compiere.model.X_M_InOutConfirm
CONFIRMTYPE_AD_Reference_ID, CONFIRMTYPE_CustomerConfirmation, CONFIRMTYPE_DropShipConfirm, CONFIRMTYPE_PickQAConfirm, CONFIRMTYPE_ShipReceiptConfirm, CONFIRMTYPE_VendorConfirmation, 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_WaitingPaymentFields 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_IDFields 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_WaitingPaymentFields inherited from interface org.compiere.model.I_M_InOutConfirm
accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_ApprovalAmt, COLUMNNAME_C_Invoice_ID, COLUMNNAME_ConfirmationNo, COLUMNNAME_ConfirmType, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_CreatePackage, COLUMNNAME_Description, COLUMNNAME_DocAction, COLUMNNAME_DocStatus, COLUMNNAME_DocumentNo, COLUMNNAME_IsActive, COLUMNNAME_IsApproved, COLUMNNAME_IsCancelled, COLUMNNAME_IsInDispute, COLUMNNAME_M_InOut_ID, COLUMNNAME_M_InOutConfirm_ID, COLUMNNAME_M_InOutConfirm_UU, COLUMNNAME_M_Inventory_ID, COLUMNNAME_Processed, COLUMNNAME_Processing, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name -
Constructor Summary
ConstructorsConstructorDescriptionMInOutConfirm(Properties ctx, int M_InOutConfirm_ID, String trxName) Standard ConstructorMInOutConfirm(Properties ctx, String M_InOutConfirm_UU, String trxName) UUID based ConstructorMInOutConfirm(Properties ctx, ResultSet rs, String trxName) Load ConstructorMInOutConfirm(MInOut ship, String confirmType) Parent Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDescription(String description) Add to DescriptionbooleanApprove DocumentbooleancloseIt()Close Document.Complete Documentstatic MInOutConfirmCreate Confirmation or return existing oneCreate PDFCreate PDF fileintGet Document CurrencyGet Name of ConfirmTypeintGet Document Owner (Responsible)Get Document InfogetLines(boolean requery) Get LinesGet Process MessageGet SummarybooleanInvalidate DocumentbooleanDocument Status is Complete or ClosedPrepare DocumentbooleanProcess documentbooleanRe-activatebooleanrejectIt()Reject ApprovalbooleanReverse Accrual - nonebooleanReverse CorrectionvoidsetIsApproved(boolean IsApproved) Set Approved and update description (if IsApproved=true)toString()String RepresentationbooleanunlockIt()Unlock Document.booleanvoidIt()Void Document.Methods inherited from class org.compiere.model.X_M_InOutConfirm
get_AccessLevel, getApprovalAmt, getC_Invoice, getC_Invoice_ID, getConfirmationNo, getConfirmType, getCreatePackage, getDescription, getDocAction, getDocStatus, getDocumentNo, getKeyNamePair, getM_InOut, getM_InOut_ID, getM_InOutConfirm_ID, getM_InOutConfirm_UU, getM_Inventory, getM_Inventory_ID, initPO, isApproved, isCancelled, isInDispute, isProcessed, isProcessing, setApprovalAmt, setC_Invoice_ID, setConfirmationNo, setConfirmType, setCreatePackage, setDescription, setDocAction, setDocStatus, setDocumentNo, setIsCancelled, setIsInDispute, setM_InOut_ID, setM_InOutConfirm_ID, setM_InOutConfirm_UU, setM_Inventory_ID, setProcessed, setProcessingMethods inherited from class org.compiere.model.PO
afterDelete, afterSave, beforeDelete, beforeSave, 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, validForeignKeysExMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLongMethods inherited from interface org.compiere.process.DocAction
get_ID, get_Logger, get_Table_ID, get_TrxName, getAD_Client_ID, getAD_Org_ID, getApprovalAmt, getCtx, getDocAction, getDocStatus, getDocumentNo, save, saveEx, setDocStatusMethods inherited from interface org.compiere.model.I_M_InOutConfirm
getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActiveMethods inherited from interface org.compiere.model.I_Persistent
save
-
Constructor Details
-
MInOutConfirm
UUID based Constructor- Parameters:
ctx- ContextM_InOutConfirm_UU- UUID keytrxName- Transaction
-
MInOutConfirm
Standard Constructor- Parameters:
ctx- contextM_InOutConfirm_ID- idtrxName- transaction
-
MInOutConfirm
Load Constructor- Parameters:
ctx- contextrs- result settrxName- transaction
-
MInOutConfirm
Parent Constructor- Parameters:
ship- shipmentconfirmType- confirmation type
-
-
Method Details
-
create
Create Confirmation or return existing one- Parameters:
ship- shipmentconfirmType- confirmation typecheckExisting- if false, new confirmation is created- Returns:
- Confirmation
-
getLines
Get Lines- Parameters:
requery- true to requery from DB- Returns:
- array of lines
-
addDescription
Add to Description- Parameters:
description- text
-
getConfirmTypeName
Get Name of ConfirmType- Returns:
- confirm type
-
toString
String Representation- Overrides:
toStringin classX_M_InOutConfirm- Returns:
- info
-
getDocumentInfo
Get Document Info- Specified by:
getDocumentInfoin interfaceDocAction- Returns:
- document info (untranslated)
-
createPDF
Create PDF -
createPDF
Create PDF file- Parameters:
file- output file- Returns:
- not implemented, always return null
-
setIsApproved
public void setIsApproved(boolean IsApproved) Set Approved and update description (if IsApproved=true)- Specified by:
setIsApprovedin interfaceI_M_InOutConfirm- Overrides:
setIsApprovedin classX_M_InOutConfirm- Parameters:
IsApproved- approval
-
processIt
Process document -
unlockIt
public boolean unlockIt()Unlock Document. -
invalidateIt
public boolean invalidateIt()Invalidate Document- Specified by:
invalidateItin interfaceDocAction- Returns:
- true if success
-
prepareIt
Prepare Document -
approveIt
public boolean approveIt()Approve Document -
rejectIt
public boolean rejectIt()Reject Approval -
completeIt
Complete Document- Specified by:
completeItin interfaceDocAction- Returns:
- new status (Complete, In Progress, Invalid, Waiting ..)
-
voidIt
public boolean voidIt()Void Document. -
closeIt
public boolean closeIt()Close Document. -
reverseCorrectIt
public boolean reverseCorrectIt()Reverse Correction- Specified by:
reverseCorrectItin interfaceDocAction- Returns:
- false
-
reverseAccrualIt
public boolean reverseAccrualIt()Reverse Accrual - none- Specified by:
reverseAccrualItin interfaceDocAction- Returns:
- false
-
reActivateIt
public boolean reActivateIt()Re-activate- Specified by:
reActivateItin interfaceDocAction- Returns:
- false
-
getSummary
Get Summary- Specified by:
getSummaryin interfaceDocAction- Returns:
- Summary of Document
-
getProcessMsg
Get Process Message- Specified by:
getProcessMsgin interfaceDocAction- Returns:
- clear text error message
-
getDoc_User_ID
public int getDoc_User_ID()Get Document Owner (Responsible)- Specified by:
getDoc_User_IDin interfaceDocAction- Returns:
- AD_User_ID
-
getC_Currency_ID
public int getC_Currency_ID()Get Document Currency- Specified by:
getC_Currency_IDin interfaceDocAction- Returns:
- C_Currency_ID
-
isComplete
public boolean isComplete()Document Status is Complete or Closed- Returns:
- true if CO, CL or RE
-