Package org.compiere.model

Class MTimeExpense

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_S_TimeExpense

org.compiere.model.MTimeExpense

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_Persistent, I_S_TimeExpense, DocAction, Evaluatee

public class MTimeExpense
extends X_S_TimeExpense
implements DocAction

Time + Expense Model

Version:

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

Author:

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

FR [ 2520591 ] Support multiples calendar for Org

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_S_TimeExpense

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, LOCAL_TRX_PREFIX, 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_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_S_TimeExpense

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_ApprovalAmt, COLUMNNAME_C_BPartner_ID, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_DateReport, COLUMNNAME_Description, COLUMNNAME_DocAction, COLUMNNAME_DocStatus, COLUMNNAME_DocumentNo, COLUMNNAME_IsActive, COLUMNNAME_IsApproved, COLUMNNAME_M_PriceList_ID, COLUMNNAME_M_Warehouse_ID, COLUMNNAME_Processed, COLUMNNAME_Processing, COLUMNNAME_S_TimeExpense_ID, COLUMNNAME_S_TimeExpense_UU, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MTimeExpense(Properties ctx, int S_TimeExpense_ID, String trxName)	Default Constructor
MTimeExpense(Properties ctx, ResultSet rs, String trxName)	Load Constructor

Method Summary

Modifier and Type	Method	Description
void	addDescription(String description)	Add to Description
boolean	approveIt()	Approve Document
boolean	closeIt()	Close Document.
String	completeIt()	Complete Document
File	createPDF()	Create PDF
File	createPDF(File file)	Create PDF file
int	getC_Currency_ID()	Get Document Currency
int	getDoc_User_ID()	Get Document Owner (Responsible)
String	getDocumentInfo()	Get Document Info
MTimeExpenseLine[]	getLines()	Get Lines Convenience Wrapper
MTimeExpenseLine[]	getLines(boolean requery)	Get Lines
int	getM_Locator_ID()	Get Default Locator (from Warehouse)
String	getProcessMsg()	Get Process Message
String	getSummary()	Get Summary
boolean	invalidateIt()	Invalidate Document
boolean	isComplete()	Document Status is Complete or Closed
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	setProcessed(boolean processed)	Set Processed.
boolean	unlockIt()	Unlock Document.
boolean	voidIt()	Void Document.

Methods inherited from class org.compiere.model.X_S_TimeExpense

get_AccessLevel, getApprovalAmt, getC_BPartner, getC_BPartner_ID, getDateReport, getDescription, getDocAction, getDocStatus, getDocumentNo, getKeyNamePair, getM_PriceList, getM_PriceList_ID, getM_Warehouse, getM_Warehouse_ID, getS_TimeExpense_ID, getS_TimeExpense_UU, initPO, isApproved, isProcessed, isProcessing, setApprovalAmt, setC_BPartner_ID, setDateReport, setDescription, setDocAction, setDocStatus, setDocumentNo, setIsApproved, setM_PriceList_ID, setM_Warehouse_ID, setProcessing, setS_TimeExpense_ID, setS_TimeExpense_UU, toString

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, beforeSave, 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_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, 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, load, loadByUU, loadComplete, loadDefaults, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, 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, unlock, update_Tree, validForeignKeys

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, getApprovalAmt, getCtx, getDocAction, getDocStatus, getDocumentNo, save, saveEx, setDocStatus

Methods inherited from interface org.compiere.model.I_Persistent

save

Methods inherited from interface org.compiere.model.I_S_TimeExpense

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Constructor Detail

MTimeExpense

public MTimeExpense(Properties ctx,
                    int S_TimeExpense_ID,
                    String trxName)

Default Constructor

Parameters:

ctx - context

S_TimeExpense_ID - id

trxName - transaction

MTimeExpense

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

Method Detail

getLines

public MTimeExpenseLine[] getLines()

Get Lines Convenience Wrapper

Returns:

array of lines

getLines

public MTimeExpenseLine[] getLines(boolean requery)

Get Lines

Parameters:

requery - true requeries

Returns:

array of lines

addDescription

public void addDescription(String description)

Add to Description

Parameters:

description - text

getM_Locator_ID

public int getM_Locator_ID()

Get Default Locator (from Warehouse)

Returns:

locator

setProcessed

public void setProcessed(boolean processed)

Set Processed. Propergate to Lines/Taxes

Specified by:

setProcessed in interface I_S_TimeExpense

Overrides:

setProcessed in class X_S_TimeExpense

Parameters:

processed - processed

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:

file if success

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:

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:

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

isComplete

public boolean isComplete()

Document Status is Complete or Closed

Returns:

true if CO, CL or RE