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, Comparator, I_M_InOutConfirm, I_Persistent, DocAction, Evaluatee

public class MInOutConfirm
extends X_M_InOutConfirm
implements DocAction

Shipment Confirmation Model

Version:

$Id: MInOutConfirm.java,v 1.3 2006/07/30 00:51:03 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

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_WaitingPayment

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, log, p_ctx, p_info, 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_ReOpen, ACTION_Reverse_Accrual, ACTION_Reverse_Correct, ACTION_Unlock, ACTION_Void, ACTION_WaitComplete, AD_REFERENCE_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_InOutConfirm

accessLevel, COLUMNNAME_ApprovalAmt, COLUMNNAME_C_Invoice_ID, COLUMNNAME_ConfirmationNo, COLUMNNAME_ConfirmType, COLUMNNAME_CreatePackage, COLUMNNAME_Description, COLUMNNAME_DocAction, COLUMNNAME_DocStatus, COLUMNNAME_DocumentNo, COLUMNNAME_IsApproved, COLUMNNAME_IsCancelled, COLUMNNAME_IsInDispute, COLUMNNAME_M_InOut_ID, COLUMNNAME_M_InOutConfirm_ID, COLUMNNAME_M_Inventory_ID, COLUMNNAME_Processed, COLUMNNAME_Processing, Model, Table_ID, Table_Name

Constructor Summary

MInOutConfirm(MInOut ship, String confirmType)
Parent Constructor

MInOutConfirm(Properties ctx, int M_InOutConfirm_ID, String trxName)
Standard Constructor

MInOutConfirm(Properties ctx, ResultSet rs, String trxName)
Load Constructor

Method Summary

void	addDescription(String description) Add to Description
boolean	approveIt() Approve Document
boolean	closeIt() Close Document.
String	completeIt() Complete Document
static MInOutConfirm	create(MInOut ship, String confirmType, boolean checkExisting) Create Confirmation or return existing one
File	createPDF() Create PDF
File	createPDF(File file) Create PDF file
int	getC_Currency_ID() Get Document Currency
String	getConfirmTypeName() Get Name of ConfirmType
int	getDoc_User_ID() Get Document Owner (Responsible)
String	getDocumentInfo() Get Document Info
MInOutLineConfirm[]	getLines(boolean requery) Get Lines
String	getProcessMsg() Get Process Message
String	getSummary() Get Summary
boolean	invalidateIt() Invalidate Document
String	prepareIt() Prepare Document
boolean	processIt(String processAction) Process document
boolean	reActivateIt() Re-activate
boolean	rejectIt() Reject Approval
boolean	reverseAccrualIt() Reverse Accrual - none
boolean	reverseCorrectIt() Reverse Correction
void	setIsApproved(boolean IsApproved) Set Approved
String	toString() String Representation
boolean	unlockIt() Unlock Document.
boolean	voidIt() Void Document.

Methods inherited from class org.compiere.model.X_M_InOutConfirm

get_AccessLevel, getApprovalAmt, getC_Invoice_ID, getC_Invoice, getConfirmationNo, getConfirmType, getCreatePackage, getDescription, getDocAction, getDocStatus, getDocumentNo, getKeyNamePair, getM_InOut_ID, getM_InOut, getM_InOutConfirm_ID, getM_Inventory_ID, getM_Inventory, 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_Inventory_ID, setProcessed, setProcessing

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, beforeSave, compare, copyValues, copyValues, createAttachment, delete_Accounting, delete_Tree, delete, delete, deleteEx, deleteEx, dump, dump, equals, 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_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveEx, saveEx, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setDoc, setDocWorkflowMgr, setIsActive, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods 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, setDocStatus

Methods inherited from interface org.compiere.model.I_Persistent

save

Constructor Detail

MInOutConfirm

public MInOutConfirm(Properties ctx,
                     int M_InOutConfirm_ID,
                     String trxName)

Standard Constructor

Parameters:

ctx - context

M_InOutConfirm_ID - id

trxName - transaction

MInOutConfirm

public MInOutConfirm(Properties ctx,
                     ResultSet rs,
                     String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MInOutConfirm

public MInOutConfirm(MInOut ship,
                     String confirmType)

Parent Constructor

Parameters:

ship - shipment

confirmType - confirmation type

Method Detail

create

public static MInOutConfirm create(MInOut ship,
                                   String confirmType,
                                   boolean checkExisting)

Create Confirmation or return existing one

Parameters:

ship - shipment

confirmType - confirmation type

checkExisting - if false, new confirmation is created

Returns:

Confirmation

getLines

public MInOutLineConfirm[] getLines(boolean requery)

Get Lines

Parameters:

requery - requery

Returns:

array of lines

addDescription

public void addDescription(String description)

Add to Description

Parameters:

description - text

getConfirmTypeName

public String getConfirmTypeName()

Get Name of ConfirmType

Returns:

confirm type

toString

public String toString()

String Representation

Overrides:

toString in class X_M_InOutConfirm

Returns:

info

getDocumentInfo

public String getDocumentInfo()

Get Document Info

Specified by:

getDocumentInfo in interface DocAction

Returns:

document info (untranslated)

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:

file if success

setIsApproved

public void setIsApproved(boolean IsApproved)

Set Approved

Specified by:

setIsApproved in interface I_M_InOutConfirm

Overrides:

setIsApproved in class X_M_InOutConfirm

Parameters:

IsApproved - approval

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.

Specified by:

voidIt in interface DocAction

Returns:

false

closeIt

public boolean closeIt()

Close Document.

Specified by:

closeIt in interface DocAction

Returns:

true if success

reverseCorrectIt

public boolean reverseCorrectIt()

Reverse Correction

Specified by:

reverseCorrectIt in interface DocAction

Returns:

false

reverseAccrualIt

public boolean reverseAccrualIt()

Reverse Accrual - none

Specified by:

reverseAccrualIt in interface DocAction

Returns:

false

reActivateIt

public boolean reActivateIt()

Re-activate

Specified by:

reActivateIt in interface DocAction

Returns:

false

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 (Responsible)

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