org.compiere.model
Class MDocType

java.lang.Object
  org.compiere.model.PO
      org.compiere.model.X_C_DocType
          org.compiere.model.MDocType

All Implemented Interfaces:

Serializable, Comparator, I_C_DocType, I_Persistent, Evaluatee

public class MDocType
extends X_C_DocType

Document Type Model

Version:

$Id: MDocType.java,v 1.3 2006/07/30 00:54:54 jjanke Exp $

Author:

Jorg Janke, Karsten Thiemann FR [ 1782412 ]

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_C_DocType

C_DOCTYPEDIFFERENCE_ID_AD_Reference_ID, C_DOCTYPEINVOICE_ID_AD_Reference_ID, C_DOCTYPEPROFORMA_ID_AD_Reference_ID, C_DOCTYPESHIPMENT_ID_AD_Reference_ID, DEFINITESEQUENCE_ID_AD_Reference_ID, DOCBASETYPE_AD_Reference_ID, DOCBASETYPE_APCreditMemo, DOCBASETYPE_APInvoice, DOCBASETYPE_APPayment, DOCBASETYPE_ARCreditMemo, DOCBASETYPE_ARInvoice, DOCBASETYPE_ARProFormaInvoice, DOCBASETYPE_ARReceipt, DOCBASETYPE_BankStatement, DOCBASETYPE_CashJournal, DOCBASETYPE_DistributionOrder, DOCBASETYPE_GLDocument, DOCBASETYPE_GLJournal, DOCBASETYPE_MaintenanceOrder, DOCBASETYPE_ManufacturingOperationActivity, DOCBASETYPE_ManufacturingOrder, DOCBASETYPE_ManufacturingOrderIssue, DOCBASETYPE_ManufacturingOrderMethodVariation, DOCBASETYPE_ManufacturingOrderRateVariation, DOCBASETYPE_ManufacturingOrderReceipt, DOCBASETYPE_ManufacturingOrderUseVariation, DOCBASETYPE_MatchInvoice, DOCBASETYPE_MatchPO, DOCBASETYPE_MaterialDelivery, DOCBASETYPE_MaterialMovement, DOCBASETYPE_MaterialPhysicalInventory, DOCBASETYPE_MaterialProduction, DOCBASETYPE_MaterialReceipt, DOCBASETYPE_PaymentAllocation, DOCBASETYPE_Payroll, DOCBASETYPE_ProjectIssue, DOCBASETYPE_PurchaseOrder, DOCBASETYPE_PurchaseRequisition, DOCBASETYPE_QualityOrder, DOCBASETYPE_SalesOrder, DOCNOSEQUENCE_ID_AD_Reference_ID, DOCSUBTYPESO_AD_Reference_ID, DOCSUBTYPESO_OnCreditOrder, DOCSUBTYPESO_POSOrder, DOCSUBTYPESO_PrepayOrder, DOCSUBTYPESO_Proposal, DOCSUBTYPESO_Quotation, DOCSUBTYPESO_ReturnMaterial, DOCSUBTYPESO_StandardOrder, DOCSUBTYPESO_WarehouseOrder

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.model.I_C_DocType

accessLevel, COLUMNNAME_AD_PrintFormat_ID, COLUMNNAME_C_DocType_ID, COLUMNNAME_C_DocTypeDifference_ID, COLUMNNAME_C_DocTypeInvoice_ID, COLUMNNAME_C_DocTypeProforma_ID, COLUMNNAME_C_DocTypeShipment_ID, COLUMNNAME_DefiniteSequence_ID, COLUMNNAME_Description, COLUMNNAME_DocBaseType, COLUMNNAME_DocNoSequence_ID, COLUMNNAME_DocSubTypeSO, COLUMNNAME_DocumentCopies, COLUMNNAME_DocumentNote, COLUMNNAME_GL_Category_ID, COLUMNNAME_HasCharges, COLUMNNAME_HasProforma, COLUMNNAME_IsCreateCounter, COLUMNNAME_IsDefault, COLUMNNAME_IsDefaultCounterDoc, COLUMNNAME_IsDocNoControlled, COLUMNNAME_IsIndexed, COLUMNNAME_IsInTransit, COLUMNNAME_IsOverwriteDateOnComplete, COLUMNNAME_IsOverwriteSeqOnComplete, COLUMNNAME_IsPickQAConfirm, COLUMNNAME_IsShipConfirm, COLUMNNAME_IsSOTrx, COLUMNNAME_IsSplitWhenDifference, COLUMNNAME_Name, COLUMNNAME_PrintName, Model, Table_ID, Table_Name

Constructor Summary

MDocType(Properties ctx, int C_DocType_ID, String trxName)
Standard Constructor

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

MDocType(Properties ctx, String DocBaseType, String Name, String trxName)
New Constructor

Method Summary

protected boolean	afterDelete(boolean success) Executed after Delete operation.
protected boolean	afterSave(boolean newRecord, boolean success) After Save
protected boolean	beforeSave(boolean newRecord) Before Save
static MDocType	get(Properties ctx, int C_DocType_ID) Get Document Type (cached)
static MDocType[]	getOfClient(Properties ctx) Get Client Document Types
static MDocType[]	getOfDocBaseType(Properties ctx, String DocBaseType) Get Client Document Type with DocBaseType
String	getPrintName(String AD_Language) Get Print Name
boolean	isOffer() Is this a Proposal or Quotation
boolean	isProposal() Is this a Proposal (Not binding)
boolean	isQuotation() Is this a Quotation (Binding)
void	setGL_Category_ID() Set Default GL Category
void	setIsSOTrx() Set SOTrx based on document base type
String	toString() String Representation

Methods inherited from class org.compiere.model.X_C_DocType

get_AccessLevel, getAD_PrintFormat_ID, getAD_PrintFormat, getC_DocType_ID, getC_DocTypeDifference_ID, getC_DocTypeInvoice_ID, getC_DocTypeProforma_ID, getC_DocTypeShipment_ID, getDefiniteSequence_ID, getDescription, getDocBaseType, getDocNoSequence_ID, getDocSubTypeSO, getDocumentCopies, getDocumentNote, getGL_Category_ID, getGL_Category, getKeyNamePair, getName, getPrintName, initPO, isCreateCounter, isDefault, isDefaultCounterDoc, isDocNoControlled, isHasCharges, isHasProforma, isIndexed, isInTransit, isOverwriteDateOnComplete, isOverwriteSeqOnComplete, isPickQAConfirm, isShipConfirm, isSOTrx, isSplitWhenDifference, setAD_PrintFormat_ID, setC_DocType_ID, setC_DocTypeDifference_ID, setC_DocTypeInvoice_ID, setC_DocTypeProforma_ID, setC_DocTypeShipment_ID, setDefiniteSequence_ID, setDescription, setDocBaseType, setDocNoSequence_ID, setDocSubTypeSO, setDocumentCopies, setDocumentNote, setGL_Category_ID, setHasCharges, setHasProforma, setIsCreateCounter, setIsDefault, setIsDefaultCounterDoc, setIsDocNoControlled, setIsIndexed, setIsInTransit, setIsOverwriteDateOnComplete, setIsOverwriteSeqOnComplete, setIsPickQAConfirm, setIsShipConfirm, setIsSOTrx, setIsSplitWhenDifference, setName, setPrintName

Methods inherited from class org.compiere.model.PO

beforeDelete, 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.model.I_Persistent

save

Constructor Detail

MDocType

public MDocType(Properties ctx,
                int C_DocType_ID,
                String trxName)

Standard Constructor

Parameters:

ctx - context

C_DocType_ID - id

trxName - transaction

MDocType

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MDocType

public MDocType(Properties ctx,
                String DocBaseType,
                String Name,
                String trxName)

New Constructor

Parameters:

ctx - context

DocBaseType - document base type

Name - name

trxName - transaction

Method Detail

getOfDocBaseType

public static MDocType[] getOfDocBaseType(Properties ctx,
                                          String DocBaseType)

Get Client Document Type with DocBaseType

Parameters:

ctx - context

DocBaseType - base document type

Returns:

array of doc types

getOfClient

public static MDocType[] getOfClient(Properties ctx)

Get Client Document Types

Parameters:

ctx - context

Returns:

array of doc types

get

public static MDocType get(Properties ctx,
                           int C_DocType_ID)

Get Document Type (cached)

Parameters:

ctx - context

C_DocType_ID - id

Returns:

document type

setGL_Category_ID

public void setGL_Category_ID()

Set Default GL Category

setIsSOTrx

public void setIsSOTrx()

Set SOTrx based on document base type

toString

public String toString()

String Representation

Overrides:

toString in class X_C_DocType

Returns:

info

isQuotation

public boolean isQuotation()

Is this a Quotation (Binding)

Returns:

true if Quotation

isProposal

public boolean isProposal()

Is this a Proposal (Not binding)

Returns:

true if proposal

isOffer

public boolean isOffer()

Is this a Proposal or Quotation

Returns:

true if proposal or quotation

getPrintName

public String getPrintName(String AD_Language)

Get Print Name

Parameters:

AD_Language - language

Returns:

print Name if available translated

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save

Overrides:

beforeSave in class PO

Parameters:

newRecord - new

Returns:

true

afterSave

protected boolean afterSave(boolean newRecord,
                            boolean success)

After Save

Overrides:

afterSave in class PO

Parameters:

newRecord - new

success - success

Returns:

success

afterDelete

protected boolean afterDelete(boolean success)

Executed after Delete operation.

Overrides:

afterDelete in class PO

Parameters:

success - true if record deleted

Returns:

true if delete is a success