Workspace/SPlat/src/org/splat/kernel/ObjectProperties.java

   1 package org.splat.kernel;
   2 /**
   3  * Common interface of intermediate properties objects used for constructing persistent objects supporting the API Design Pattern
   4  * provided by this package.
   5  * This interface mainly provides a frame for checking the validity of arguments used by persistent object constructors.
   6  * The validity check is implemented in classes inheriting from the Persistent.Properties abstract class through the checkValidity
   7  * member function defined in this interface - see class User included in this package for an example of use.
   8  *
   9  * @see Persistent
  10  * @author    Daniel Brunier-Coulin
  11  * @copyright OPEN CASCADE 2012
  12  */
  13 public interface ObjectProperties {
  14
  15 /**
  16  * Checks the mutual compatibility of arguments previously set in the properties object.
  17  * The validity of each individual argument is supposed to be check first in the setter function of the argument.
  18  *
  19  * @throws MissedPropertyException
  20  * @throws InvalidPropertyException
  21  * @throws MultiplyDefinedException
  22  */ public void checkValidity () throws MissedPropertyException, InvalidPropertyException, MultiplyDefinedException;
  23
  24  /**
  25  * Disables the validity check.
  26  * The validity check is by default enabled when constructing an properties object.
  27  */ public void disableCheck ();
  28
  29  /**
  30  * Returns true if the validity check is enabled.
  31  */ public boolean mustBeChecked ();
  32 }