Package org.compiere.model

Interface ModelValidator

All Known Implementing Classes:
ExportModelValidator, ProductPriceValidator, SalesMgmtValidator
public interface ModelValidator
Model Validator
Version:
$Id: ModelValidator.java,v 1.2 2006/07/30 00:58:18 jjanke Exp $ 2007/02/26 laydasalasc - globalqss - Add new timings for all before/after events on documents
Author:
Jorg Janke

  • Field Details

    • TYPE_BEFORE_NEW

      static final int TYPE_BEFORE_NEW
      Model Change Type New
      See Also:

    • TYPE_NEW

      static final int TYPE_NEW
      See Also:

    • CHANGETYPE_NEW

      @Deprecated static final int CHANGETYPE_NEW
      Deprecated.
      See Also:

    • TYPE_AFTER_NEW

      static final int TYPE_AFTER_NEW
      See Also:

    • TYPE_AFTER_NEW_REPLICATION

      static final int TYPE_AFTER_NEW_REPLICATION
      See Also:

    • TYPE_BEFORE_CHANGE

      static final int TYPE_BEFORE_CHANGE
      Model Change Type Change
      See Also:

    • TYPE_CHANGE

      static final int TYPE_CHANGE
      See Also:

    • CHANGETYPE_CHANGE

      @Deprecated static final int CHANGETYPE_CHANGE
      Deprecated.
      See Also:

    • TYPE_AFTER_CHANGE

      static final int TYPE_AFTER_CHANGE
      See Also:

    • TYPE_AFTER_CHANGE_REPLICATION

      static final int TYPE_AFTER_CHANGE_REPLICATION
      See Also:

    • TYPE_BEFORE_DELETE

      static final int TYPE_BEFORE_DELETE
      Model Change Type Delete
      See Also:

    • TYPE_DELETE

      static final int TYPE_DELETE
      See Also:

    • CHANGETYPE_DELETE

      @Deprecated static final int CHANGETYPE_DELETE
      Deprecated.
      See Also:

    • TYPE_AFTER_DELETE

      static final int TYPE_AFTER_DELETE
      See Also:

    • TYPE_BEFORE_DELETE_REPLICATION

      static final int TYPE_BEFORE_DELETE_REPLICATION
      See Also:

    • tableEventValidators

      static final String[] tableEventValidators

    • tableEventTopics

      static final String[] tableEventTopics

    • TIMING_BEFORE_PREPARE

      static final int TIMING_BEFORE_PREPARE
      Called before document is prepared
      See Also:

    • DOCTIMING_BEFORE_PREPARE

      @Deprecated static final int DOCTIMING_BEFORE_PREPARE
      Deprecated.
      See Also:

    • TIMING_BEFORE_VOID

      static final int TIMING_BEFORE_VOID
      Called before document is void
      See Also:

    • TIMING_BEFORE_CLOSE

      static final int TIMING_BEFORE_CLOSE
      Called before document is close
      See Also:

    • TIMING_BEFORE_REACTIVATE

      static final int TIMING_BEFORE_REACTIVATE
      Called before document is reactivate
      See Also:

    • TIMING_BEFORE_REVERSECORRECT

      static final int TIMING_BEFORE_REVERSECORRECT
      Called before document is reversecorrect
      See Also:

    • TIMING_BEFORE_REVERSEACCRUAL

      static final int TIMING_BEFORE_REVERSEACCRUAL
      Called before document is reverseaccrual
      See Also:

    • TIMING_BEFORE_COMPLETE

      static final int TIMING_BEFORE_COMPLETE
      Called before document is completed
      See Also:

    • TIMING_AFTER_PREPARE

      static final int TIMING_AFTER_PREPARE
      Called after document is prepared
      See Also:

    • TIMING_AFTER_COMPLETE

      static final int TIMING_AFTER_COMPLETE
      Called after document is completed
      See Also:

    • DOCTIMING_AFTER_COMPLETE

      @Deprecated static final int DOCTIMING_AFTER_COMPLETE
      Deprecated.
      See Also:

    • TIMING_AFTER_VOID

      static final int TIMING_AFTER_VOID
      Called after document is void
      See Also:

    • TIMING_AFTER_CLOSE

      static final int TIMING_AFTER_CLOSE
      Called after document is closed
      See Also:

    • TIMING_AFTER_REACTIVATE

      static final int TIMING_AFTER_REACTIVATE
      Called after document is reactivated
      See Also:

    • TIMING_AFTER_REVERSECORRECT

      static final int TIMING_AFTER_REVERSECORRECT
      Called after document is reversecorrect
      See Also:

    • TIMING_AFTER_REVERSEACCRUAL

      static final int TIMING_AFTER_REVERSEACCRUAL
      Called after document is reverseaccrual
      See Also:

    • TIMING_BEFORE_POST

      static final int TIMING_BEFORE_POST
      Called before document is posted
      See Also:

    • TIMING_AFTER_POST

      static final int TIMING_AFTER_POST
      Called after document is posted
      See Also:

    • documentEventValidators

      static final String[] documentEventValidators

    • documentEventTopics

      static final String[] documentEventTopics

  • Method Details

    • initialize

      void initialize(ModelValidationEngine engine, MClient client)
      Initialize validator.
      Parameters:
      engine - validation engine
      client - optional client. null for validator that's applicable to all client.

    • getAD_Client_ID

      int getAD_Client_ID()
      Get Client to be monitored
      Returns:
      AD_Client_ID or 0

    • login

      String login(int AD_Org_ID, int AD_Role_ID, int AD_User_ID)
      User logged in. Called before preferences are set.
      Parameters:
      AD_Org_ID - org
      AD_Role_ID - role
      AD_User_ID - user
      Returns:
      error message or null

    • modelChange

      String modelChange(PO po, int type) throws Exception
      Model change event of a Table.
      Parameters:
      po - persistent object
      type - TYPE_ event
      Returns:
      error message or null
      Throws:
      Exception - if the recipient wishes the change to be not accept.

    • docValidate

      String docValidate(PO po, int timing)
      Validate Document Action.
      Called as first step of DocAction.prepareIt or at the end of DocAction.completeIt.
      Note that totals, etc. may not be correct before the prepare stage.
      Parameters:
      po - persistent object
      timing - see TIMING_ constants
      Returns:
      error message or null - if not null, the document will be marked as Invalid.