Package org.compiere.model

Class MPeriodControl

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_C_PeriodControl

org.compiere.model.MPeriodControl

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_C_PeriodControl, I_Persistent, Evaluatee, ImmutablePOSupport

public class MPeriodControl
extends X_C_PeriodControl
implements ImmutablePOSupport

Period Control Model

Version:

$Id: MPeriodControl.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_C_PeriodControl

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_FixedAssetsAddition, DOCBASETYPE_FixedAssetsDepreciation, DOCBASETYPE_FixedAssetsDisposal, DOCBASETYPE_GLDocument, DOCBASETYPE_GLJournal, DOCBASETYPE_MaintenanceOrder, DOCBASETYPE_ManufacturingCostCollector, DOCBASETYPE_ManufacturingOrder, 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, PERIODACTION_AD_Reference_ID, PERIODACTION_ClosePeriod, PERIODACTION_DocumentClosePeriod, PERIODACTION_NoAction, PERIODACTION_OpenPeriod, PERIODACTION_PermanentlyClosePeriod, PERIODSTATUS_AD_Reference_ID, PERIODSTATUS_Closed, PERIODSTATUS_DocumentClosed, PERIODSTATUS_NeverOpened, PERIODSTATUS_Open, PERIODSTATUS_PermanentlyClosed

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

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_C_Period_ID, COLUMNNAME_C_PeriodControl_ID, COLUMNNAME_C_PeriodControl_UU, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_DocBaseType, COLUMNNAME_IsActive, COLUMNNAME_PeriodAction, COLUMNNAME_PeriodStatus, COLUMNNAME_Processing, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MPeriodControl(Properties ctx, int AD_Client_ID, int C_Period_ID, String DocBaseType, String trxName)	New Constructor
MPeriodControl(Properties ctx, int C_PeriodControl_ID, String trxName)	Standard Constructor
MPeriodControl(Properties ctx, String C_PeriodControl_UU, String trxName)	UUID based Constructor
MPeriodControl(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MPeriodControl(Properties ctx, MPeriodControl copy)	Copy constructor
MPeriodControl(Properties ctx, MPeriodControl copy, String trxName)	Copy constructor
MPeriodControl(MPeriodControl copy)	Copy constructor
MPeriodControl(MPeriod period, String DocBaseType)	Parent Constructor

Method Summary

Modifier and Type	Method	Description
boolean	isOpen()	Is Open
boolean	isOpen(boolean forPosting)	Is Open
MPeriodControl	markImmutable()	mark PO as immutable
String	toString()	String Representation

Methods inherited from class org.compiere.model.X_C_PeriodControl

get_AccessLevel, getC_Period, getC_Period_ID, getC_PeriodControl_ID, getC_PeriodControl_UU, getDocBaseType, getKeyNamePair, getPeriodAction, getPeriodStatus, initPO, isProcessing, setC_Period_ID, setC_PeriodControl_ID, setC_PeriodControl_UU, setDocBaseType, setPeriodAction, setPeriodStatus, setProcessing

Methods 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_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

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

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

MPeriodControl

public MPeriodControl(Properties ctx,
 String C_PeriodControl_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

C_PeriodControl_UU - UUID key

trxName - Transaction

MPeriodControl

public MPeriodControl(Properties ctx,
 int C_PeriodControl_ID,
 String trxName)

Standard Constructor

Parameters:

ctx - context

C_PeriodControl_ID - 0

trxName - transaction

MPeriodControl

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MPeriodControl

public MPeriodControl(MPeriod period,
 String DocBaseType)

Parent Constructor

Parameters:

period - parent

DocBaseType - doc base type

MPeriodControl

public MPeriodControl(Properties ctx,
 int AD_Client_ID,
 int C_Period_ID,
 String DocBaseType,
 String trxName)

New Constructor

Parameters:

ctx - context

AD_Client_ID - client

C_Period_ID - period

DocBaseType - doc base type

trxName - transaction

MPeriodControl

public MPeriodControl(MPeriodControl copy)

Copy constructor

Parameters:

copy -

MPeriodControl

public MPeriodControl(Properties ctx,
 MPeriodControl copy)

Copy constructor

Parameters:

ctx -

copy -

MPeriodControl

public MPeriodControl(Properties ctx,
 MPeriodControl copy,
 String trxName)

Copy constructor

Parameters:

ctx -

copy -

trxName -

Method Details

isOpen

public boolean isOpen()

Is Open

Returns:

true if open

isOpen

public boolean isOpen(boolean forPosting)

Is Open

Parameters:

forPosting - - true to check if the period is open for posting, false is for DocAction

Returns:

true if open

toString

public String toString()

String Representation

Overrides:

toString in class X_C_PeriodControl

Returns:

info

markImmutable

public MPeriodControl markImmutable()

Description copied from interface: ImmutablePOSupport

mark PO as immutable

Specified by:

markImmutable in interface ImmutablePOSupport

Returns:

PO