org.compiere.model
Class MPeriod

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

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, 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

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_C_Period

accessLevel, Model, PERIODTYPE_AD_Reference_ID, PERIODTYPE_AdjustmentPeriod, PERIODTYPE_StandardCalendarPeriod, Table_ID, Table_Name, updatedMS

Fields inherited from class org.compiere.framework.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, log, p_changeVO, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Constructor Summary

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

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

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

Method Summary

protected boolean	afterSave(boolean newRecord, boolean success) After Save
protected boolean	beforeSave(boolean newRecord) Before Save.
static MPeriod	get(Ctx ctx, int C_Period_ID) Get Period from Cache
int	getC_Calendar_ID() Get Calendar of Period
static int	getC_Period_ID(Ctx ctx, int AD_Org_ID, Timestamp DateAcct) Find valid standard Period of DateAcct based on Client Calendar
static MPeriod	getFirstInYear(Ctx ctx, int C_Calendar_ID, Timestamp DateAcct) Find first Year Period of DateAcct based on Client Calendar
static MPeriod	getOfCalendar(Ctx ctx, int C_Calendar_ID, Timestamp DateAcct) Find standard Period of DateAcct based on Client Calendar
static MPeriod	getOfOrg(Ctx ctx, int AD_Org_ID, Timestamp DateAcct) Find standard 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 String	isOpen(PO header, PO[] lines, Timestamp DateAcct, String DocBaseType) Is standard Period Open for Document Base Type
String	isOpen(String DocBaseType, Timestamp dateAcct) Is Period Open for Doc Base Type
static boolean	isOpenOld(Ctx ctx, Timestamp DateAcct, String DocBaseType) Deprecated. use new isOpen
boolean	isStandardPeriod() Standard Period
String	toString() String Representation

Methods inherited from class org.compiere.model.X_C_Period

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

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, afterDelete, beforeDelete, compare, convertToBigDecimal, convertToBoolean, convertToInt, convertToTimestamp, copy, copyValues, copyValues, createAttachment, delete_Accounting, delete, delete, dump, dump, equals, get_ChangeVO, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_EntityType, get_HashMap, get_ID, get_IDOld, get_Info, get_KeyColumns, get_Logger, get_Table_ID, get_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_ValuesAsString, get_WhereClause, get_xmlDocument, get_xmlString, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getVO, hashCode, insert_Accounting, is_Changed, is_KeyColumn, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveNew_getID, saveNewInsertSQL, saveNewSpecial, saveUpdate, set_ChangeVO, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueString, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setContext, setCtx, setDocWorkflowMgr, setIsActive, setStandardDefaults, setUpdateable, setUpdatedBy, toStringX, unlock, update

Methods inherited from class java.lang.Object

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

Constructor Detail

MPeriod

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

Standard Constructor

Parameters:

ctx - context

C_Period_ID - id

trxName - transaction

MPeriod

public MPeriod(Ctx 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(Ctx ctx,
                          int C_Period_ID)

Get Period from Cache

Parameters:

ctx - context

C_Period_ID - id

Returns:

MPeriod

getOfOrg

public static MPeriod getOfOrg(Ctx ctx,
                               int AD_Org_ID,
                               Timestamp DateAcct)

Find standard Period of DateAcct based on Client Calendar

Parameters:

ctx - context

DateAcct - date

Returns:

active Period or null

getOfCalendar

public static MPeriod getOfCalendar(Ctx ctx,
                                    int C_Calendar_ID,
                                    Timestamp DateAcct)

Find standard Period of DateAcct based on Client Calendar

Parameters:

ctx - context

C_Calendar_ID - calendar

DateAcct - date

Returns:

active Period or null

getC_Period_ID

public static int getC_Period_ID(Ctx ctx,
                                 int AD_Org_ID,
                                 Timestamp DateAcct)

Find valid standard Period of DateAcct based on Client Calendar

Parameters:

ctx - context

DateAcct - date

Returns:

C_Period_ID or 0

isOpenOld

@Deprecated
public static boolean isOpenOld(Ctx ctx,
                                           Timestamp DateAcct,
                                           String DocBaseType)

Deprecated. use new isOpen

Is standard Period Open for Document Base Type

Parameters:

ctx - context

DateAcct - date

DocBaseType - base type

Returns:

true if open

isOpen

public static String isOpen(PO header,
                            PO[] lines,
                            Timestamp DateAcct,
                            String DocBaseType)

Is standard Period Open for Document Base Type

Parameters:

header - header document record

lines - document lines optional

Returns:

error message or null

getFirstInYear

public static MPeriod getFirstInYear(Ctx ctx,
                                     int C_Calendar_ID,
                                     Timestamp DateAcct)

Find first Year Period of DateAcct based on Client Calendar

Parameters:

ctx - context

C_Calendar_ID - calendar

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 String isOpen(String DocBaseType,
                     Timestamp dateAcct)

Is Period Open for Doc Base Type

Parameters:

DocBaseType - document base type

dateAcct - accounting date

Returns:

error message or null

isStandardPeriod

public boolean isStandardPeriod()

Standard Period

Returns:

true if standard calendar period

getC_Calendar_ID

public int getC_Calendar_ID()

Get Calendar of Period

Returns:

calendar

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