org.compiere.model
Class MTemplate

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_CM_Template
          org.compiere.model.MTemplate

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, Evaluatee

public class MTemplate
extends X_CM_Template

Web Template Model

Version:

$Id: MTemplate.java,v 1.12 2006/08/08 18:56:05 comdivision Exp $

Author:

Yves Sandfort

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_CM_Template

accessLevel, Model, 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

MTemplate(Ctx ctx, int CM_Template_ID, String trxName)
Standard Constructor

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

Method Summary

protected boolean	afterDelete(boolean success) After Delete
protected boolean	afterSave(boolean newRecord, boolean success) After Save.
protected boolean	beforeSave(boolean newRecord) Before Save
static MTemplate	get(Ctx ctx, int CM_Template_ID, String trxName) Get MTemplate from Cache
int	getAD_Tree_ID() Get AD_Tree_ID
MAd[]	getAds() Get's all the Ads from Template AD Cat (including all subtemplates)
static MTemplate	getByName(Ctx ctx, String name, int projectID, String trxName) get Template by Name
StringBuffer	getPreBuildTemplate() Get the Template we prebuild (this means with added subtemplates)
MWebProject	getWebProject() Get Web Project
boolean	isNews(boolean includeSub) Check for isNews if needed including subtemplates
boolean	isRequest(boolean includeSub) Check whether we need to include Request data
boolean	isUseAd(boolean includeSub) Check for isUseAd if needed including subtemplates
void	rebuildTemplate() Prebuild Template, this also set's parameters of subtemplates on the main template

Methods inherited from class org.compiere.model.X_CM_Template

get_AccessLevel, getCM_Template_ID, getCM_WebProject_ID, getDescription, getElements, getHelp, getKeyNamePair, getName, getTemplateXST, getValue, initPO, isInclude, isNews, isProcessing, isSummary, isUseAd, isValid, setCM_Template_ID, setCM_WebProject_ID, setDescription, setElements, setHelp, setIsInclude, setIsNews, setIsSummary, setIsUseAd, setIsValid, setName, setProcessing, setTemplateXST, setValue, toString

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, 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

MTemplate

public MTemplate(Ctx ctx,
                 int CM_Template_ID,
                 String trxName)

Standard Constructor

Parameters:

ctx - context

CM_Template_ID - id

trxName - transaction

MTemplate

public MTemplate(Ctx ctx,
                 ResultSet rs,
                 String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

Method Detail

get

public static MTemplate get(Ctx ctx,
                            int CM_Template_ID,
                            String trxName)

Get MTemplate from Cache

Parameters:

ctx - context

CM_Template_ID - id

trxName - Transaction

Returns:

MWebProject

getByName

public static MTemplate getByName(Ctx ctx,
                                  String name,
                                  int projectID,
                                  String trxName)

get Template by Name

Parameters:

ctx -

name -

projectID -

trxName -

Returns:

Template

getWebProject

public MWebProject getWebProject()

Get Web Project

Returns:

web project

getAD_Tree_ID

public int getAD_Tree_ID()

Get AD_Tree_ID

Returns:

tree

isUseAd

public boolean isUseAd(boolean includeSub)

Check for isUseAd if needed including subtemplates

Parameters:

includeSub -

Returns:

m_isUseAd

isNews

public boolean isNews(boolean includeSub)

Check for isNews if needed including subtemplates

Parameters:

includeSub -

Returns:

m_isNews

isRequest

public boolean isRequest(boolean includeSub)

Check whether we need to include Request data

Parameters:

includeSub -

Returns:

m_isRequest

getPreBuildTemplate

public StringBuffer getPreBuildTemplate()

Get the Template we prebuild (this means with added subtemplates)

Returns:

StringBuffer with complete XSL Template

rebuildTemplate

public void rebuildTemplate()

Prebuild Template, this also set's parameters of subtemplates on the main template

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. Insert - create tree

Overrides:

afterSave in class PO

Parameters:

newRecord - insert

success - save success

Returns:

true if saved

afterDelete

protected boolean afterDelete(boolean success)

After Delete

Overrides:

afterDelete in class PO

Parameters:

success -

Returns:

deleted

getAds

public MAd[] getAds()

Get's all the Ads from Template AD Cat (including all subtemplates)

Returns:

Array of MAds