org.compiere.model
Class ModelValidationEngine

java.lang.Object
  org.compiere.model.ModelValidationEngine

public class ModelValidationEngine
extends Object

Model Validation Engine

Version:

$Id: ModelValidationEngine.java,v 1.2 2006/07/30 00:58:38 jjanke Exp $

Author:

Jorg Janke, Teo Sarca, SC ARHIPAC SERVICE SRL

FR [ 1670025 ] ModelValidator.afterLoadPreferences will be useful

BF [ 1679692 ] fireDocValidate doesn't treat exceptions as errors

FR [ 1724662 ] Support Email should contain model validators info

Method Summary

void	addDocValidate(String tableName, ModelValidator listener) Add Document Validation Listener
void	addFactsValidate(String tableName, FactsValidator listener) Add Accounting Facts Validation Listener
void	addModelChange(String tableName, ModelValidator listener) Add Model Change Listener
void	afterLoadPreferences(Properties ctx) After Load Preferences into Context for selected client.
String	fireDocValidate(PO po, int docTiming) Fire Document Validation.
String	fireFactsValidate(MAcctSchema schema, List<Fact> facts, PO po) Fire Accounting Facts Validation.
String	fireModelChange(PO po, int changeType) Fire Model Change.
static ModelValidationEngine	get() Get Singleton
StringBuffer	getInfoDetail(StringBuffer sb, Properties ctx) Create Model Validators Info
String	loginComplete(int AD_Client_ID, int AD_Org_ID, int AD_Role_ID, int AD_User_ID) Called when login is complete
void	removeDocValidate(String tableName, ModelValidator listener) Remove Document Validation Listener
void	removeFactsValidate(String tableName, FactsValidator listener) Remove Accounting Facts Validation Listener
void	removeModelChange(String tableName, ModelValidator listener) Remove Model Change Listener
String	toString() String Representation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

get

public static ModelValidationEngine get()

Get Singleton

Returns:

engine

loginComplete

public String loginComplete(int AD_Client_ID,
                            int AD_Org_ID,
                            int AD_Role_ID,
                            int AD_User_ID)

Called when login is complete

Parameters:

AD_Client_ID - client

AD_Org_ID - org

AD_Role_ID - role

AD_User_ID - user

Returns:

error message or null

addModelChange

public void addModelChange(String tableName,
                           ModelValidator listener)

Add Model Change Listener

Parameters:

tableName - table name

listener - listener

removeModelChange

public void removeModelChange(String tableName,
                              ModelValidator listener)

Remove Model Change Listener

Parameters:

tableName - table name

listener - listener

fireModelChange

public String fireModelChange(PO po,
                              int changeType)

Fire Model Change. Call modelChange method of added validators

Parameters:

po - persistent objects

type - ModelValidator.TYPE_*

Returns:

error message or NULL for no veto

addDocValidate

public void addDocValidate(String tableName,
                           ModelValidator listener)

Add Document Validation Listener

Parameters:

tableName - table name

listener - listener

removeDocValidate

public void removeDocValidate(String tableName,
                              ModelValidator listener)

Remove Document Validation Listener

Parameters:

tableName - table name

listener - listener

fireDocValidate

public String fireDocValidate(PO po,
                              int docTiming)

Fire Document Validation. Call docValidate method of added validators

Parameters:

po - persistent objects

timing - see ModelValidator.TIMING_ constants

Returns:

error message or null

addFactsValidate

public void addFactsValidate(String tableName,
                             FactsValidator listener)

Add Accounting Facts Validation Listener

Parameters:

tableName - table name

listener - listener

removeFactsValidate

public void removeFactsValidate(String tableName,
                                FactsValidator listener)

Remove Accounting Facts Validation Listener

Parameters:

tableName - table name

listener - listener

fireFactsValidate

public String fireFactsValidate(MAcctSchema schema,
                                List<Fact> facts,
                                PO po)

Fire Accounting Facts Validation. Call factsValidate method of added validators

Parameters:

schema -

facts -

doc -

po -

Returns:

error message or null

toString

public String toString()

String Representation

Overrides:

toString in class Object

Returns:

info

getInfoDetail

public StringBuffer getInfoDetail(StringBuffer sb,
                                  Properties ctx)

Create Model Validators Info

Parameters:

sb - optional string buffer

ctx - context

Returns:

Model Validators Info

afterLoadPreferences

public void afterLoadPreferences(Properties ctx)

After Load Preferences into Context for selected client.

Parameters:

ctx - context

See Also:

Login.loadPreferences(KeyNamePair, KeyNamePair, java.sql.Timestamp, String)