package fractal.api;

/**
 * An interface defining common error values returned by methods of the
 * Fractal API.
 */
public interface ErrorConst {

  /**
   * Value returned if the requested operation has been performed correctly.
   */
  int OK = 0;

  /**
   * Error value returned if the requested operation is not supported by the
   * actual implementation of the called method.
   */
  int OPERATION_NOT_SUPPORTED = -1;

  /**
   * Error value returned if an argument is invalid.
   */
  int INVALID_ARGUMENT = -2;

  /**
   * Error value returned if a requested interface does not exist.
   */
  int NO_SUCH_INTERFACE = -102;

  /**
   * Value returned if a binding operation cannot be performed.
   */
  int ILLEGAL_BINDING = -103;

  /**
   * Value returned if the component has a {@link LifeCycleController}
   * interface, but it is not in an appropriate state to perform the requested
   * operation.
   */
  int ILLEGAL_LIFE_CYCLE = -104;

  /**
   * Value returned if an operation concerning the content of a component
   * cannot be performed.
   */
  int ILLEGAL_CONTENT = -105;

  /**
   * Value returned if a requested sub component does not exist.
   */
  int NO_SUCH_SUB_COMPONENT = -106;
  
  /**
   * Value returned if a requested attribute does not exist.
   */
  int NO_SUCH_ATTRIBUTE = -107;
  
  /**
   * Value returned if a attribute operation cannot be performed.
   */
  int ILLEGAL_ATTRIBUTE = -108;
  
  /**
   * Value returned if the instantiation or the destruction of a component 
   * fails.
   */
  int INSTANTIATION_ERROR = -109;
}