org.compiere.model
Class MPeriod

java.lang.Object
  org.compiere.model.PO
      org.compiere.model.X_C_Period
          org.compiere.model.MPeriod

All Implemented Interfaces:

Serializable, Comparator, I_C_Period, I_Persistent, Evaluatee

public class MPeriod
extends X_C_Period

Calendar Period Model

Version:

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

Author:

Jorg Janke, Teo Sarca, SC ARHIPAC SERVICE SRL

BF [ 1779438 ] Minor auto period control bug

BF [ 1893486 ] Auto Period Control return that period is always open

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_C_Period

PERIODTYPE_AD_Reference_ID, PERIODTYPE_AdjustmentPeriod, PERIODTYPE_StandardCalendarPeriod

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_Period

accessLevel, COLUMNNAME_C_Period_ID, COLUMNNAME_C_Year_ID, COLUMNNAME_EndDate, COLUMNNAME_Name, COLUMNNAME_PeriodNo, COLUMNNAME_PeriodType, COLUMNNAME_Processing, COLUMNNAME_StartDate, Model, Table_ID, Table_Name

Constructor Summary

MPeriod(MYear year, int PeriodNo, String name, Timestamp startDate, Timestamp endDate)
Parent constructor

MPeriod(Properties ctx, int C_Period_ID, String trxName)
Standard Constructor

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

Method Summary

protected boolean	afterSave(boolean newRecord, boolean success) After Save
protected boolean	beforeSave(boolean newRecord) Before Save.
static MPeriod	get(Properties ctx, int C_Period_ID) Get Period from Cache
static MPeriod	get(Properties ctx, Timestamp DateAcct) Find standard Period of DateAcct based on Client Calendar
static int	getC_Period_ID(Properties ctx, Timestamp DateAcct) Find valid standard Period of DateAcct based on Client Calendar
static MPeriod	getFirstInYear(Properties ctx, Timestamp DateAcct) Find first Year Period of DateAcct based on Client Calendar
MPeriodControl	getPeriodControl(String DocBaseType) Get Period Control
MPeriodControl[]	getPeriodControls(boolean requery) Get Period Control
boolean	isInPeriod(Timestamp date) Date In Period
static boolean	isOpen(Properties ctx, Timestamp DateAcct, String DocBaseType) Is standard Period Open for Document Base Type
boolean	isOpen(String DocBaseType) Deprecated. since 3.3.1b; use isOpen(String, Timestamp) instead
boolean	isOpen(String DocBaseType, Timestamp dateAcct) Is Period Open for Doc Base Type
boolean	isStandardPeriod() Standard Period
static void	testPeriodOpen(Properties ctx, Timestamp dateAcct, int C_DocType_ID) Conventient method for testing if a period is open
static void	testPeriodOpen(Properties ctx, Timestamp dateAcct, String docBaseType) Conventient method for testing if a period is open
String	toString() String Representation

Methods inherited from class org.compiere.model.X_C_Period

get_AccessLevel, getC_Period_ID, getC_Year_ID, getC_Year, getEndDate, getKeyNamePair, getName, getPeriodNo, getPeriodType, getStartDate, initPO, isProcessing, setC_Period_ID, setC_Year_ID, setEndDate, setName, setPeriodNo, setPeriodType, setProcessing, setStartDate

Methods inherited from class org.compiere.model.PO

afterDelete, 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

MPeriod

public MPeriod(Properties ctx,
               int C_Period_ID,
               String trxName)

Standard Constructor

Parameters:

ctx - context

C_Period_ID - id

trxName - transaction

MPeriod

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MPeriod

public MPeriod(MYear year,
               int PeriodNo,
               String name,
               Timestamp startDate,
               Timestamp endDate)

Parent constructor

Parameters:

year - year

PeriodNo - no

name - name

startDate - start

endDate - end

Method Detail

get

public static MPeriod get(Properties ctx,
                          int C_Period_ID)

Get Period from Cache

Parameters:

ctx - context

C_Period_ID - id

Returns:

MPeriod

get

public static MPeriod get(Properties ctx,
                          Timestamp DateAcct)

Find standard Period of DateAcct based on Client Calendar

Parameters:

ctx - context

DateAcct - date

Returns:

active Period or null

getC_Period_ID

public static int getC_Period_ID(Properties ctx,
                                 Timestamp DateAcct)

Find valid standard Period of DateAcct based on Client Calendar

Parameters:

ctx - context

DateAcct - date

Returns:

C_Period_ID or 0

isOpen

public static boolean isOpen(Properties ctx,
                             Timestamp DateAcct,
                             String DocBaseType)

Is standard Period Open for Document Base Type

Parameters:

ctx - context

DateAcct - date

DocBaseType - base type

Returns:

true if open

getFirstInYear

public static MPeriod getFirstInYear(Properties ctx,
                                     Timestamp DateAcct)

Find first Year Period of DateAcct based on Client Calendar

Parameters:

ctx - context

DateAcct - date

Returns:

active first Period

getPeriodControls

public MPeriodControl[] getPeriodControls(boolean requery)

Get Period Control

Parameters:

requery - requery

Returns:

period controls

getPeriodControl

public MPeriodControl getPeriodControl(String DocBaseType)

Get Period Control

Parameters:

DocBaseType - Document Base Type

Returns:

period control or null

isInPeriod

public boolean isInPeriod(Timestamp date)

Date In Period

Parameters:

date - date

Returns:

true if in period

isOpen

public boolean isOpen(String DocBaseType)

Deprecated. since 3.3.1b; use isOpen(String, Timestamp) instead

Is Period Open for Doc Base Type

Parameters:

DocBaseType - document base type

Returns:

true if open

isOpen

public boolean isOpen(String DocBaseType,
                      Timestamp dateAcct)

Is Period Open for Doc Base Type

Parameters:

DocBaseType - document base type

dateAcct - date; Applies only for "Auto Period Control":

if not null, date should be in auto period range (today - OpenHistory, today+OpenHistory)

if null, this period should be in auto period range

Returns:

true if open

Since:

3.3.1b

isStandardPeriod

public boolean isStandardPeriod()

Standard Period

Returns:

true if standard calendar perios

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save. Truncate Dates

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

toString

public String toString()

String Representation

Overrides:

toString in class X_C_Period

Returns:

info

testPeriodOpen

public static void testPeriodOpen(Properties ctx,
                                  Timestamp dateAcct,
                                  String docBaseType)
                           throws PeriodClosedException

Conventient method for testing if a period is open

Parameters:

ctx -

dateAcct -

docBaseType -

Throws:

PeriodClosedException - if period is closed

See Also:

isOpen(Properties, Timestamp, String)

testPeriodOpen

public static void testPeriodOpen(Properties ctx,
                                  Timestamp dateAcct,
                                  int C_DocType_ID)
                           throws PeriodClosedException

Conventient method for testing if a period is open

Parameters:

ctx -

dateAcct -

C_DocType_ID -

Throws:

PeriodClosedException

See Also:

#isOpen(Properties, Timestamp, String)}