CheckResultInterface.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2013 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/

package org.pentaho.di.core;

public interface CheckResultInterface {

  public static final int TYPE_RESULT_NONE = 0;

  public static final int TYPE_RESULT_OK = 1;

  public static final int TYPE_RESULT_COMMENT = 2;

  public static final int TYPE_RESULT_WARNING = 3;

  public static final int TYPE_RESULT_ERROR = 4;

  /**
   * @return The type of the Check Result (0-4)
   */
  public int getType();

  /**
   * @return The internationalized type description
   */
  public String getTypeDesc();

  /**
   * @return The text of the check result.
   */
  public String getText();

  /**
   * @return The source of the check result
   */
  public CheckResultSourceInterface getSourceInfo();

  /**
   * @return String description of the check result
   */
  @Override
  public String toString();

  /**
   * @return The component-specific result code.
   */
  public String getErrorCode();

  /**
   * Sets the component-specific result/error code.
   *
   * @param errorCode
   *          Unchecked string that can be used for validation
   */
  public void setErrorCode( String errorCode );

  /**
   * Sets the check-result type
   *
   * @param value
   *          The type from 0-4
   */
  public void setType( int value );

  /**
   * Sets the text for the check-result
   *
   * @param value
   */
  public void setText( String value );

}