package at.gv.egovernment.moa.id.auth.validator;

import at.gv.egovernment.moa.id.auth.data.InfoboxValidationResult;
import at.gv.egovernment.moa.id.auth.data.InfoboxValidatorParams;

/**
 * Validates an InfoboxReadResponse.
 * An implementing class has to validate the content of the InfoboxReadResponse  
 * according to the type specific rules and guidelines of the underlying 
 * application.
 */
public interface InfoboxValidator {
  
  /**
   * This method validates an InfoboxReadResponse.
   * The method validates the content of the passed <code>infoboxReadResponse</code>
   * according to the type specific rules and guidelines of the underlying
   * application.
   *
   * @param params {@link at.gv.egovernment.moa.id.auth.data.InfoboxValidatorParams
   *                Parameters} needed by the validator.                
   * 
   * @return <code>True</code> if validation succeeds,
   *         otherwise <code>false</code>.
   *                            
   * @throws ValidateException  If an error occurs on validating the 
   *                            InfoboxReadResponse.
   */
  public InfoboxValidationResult validate (InfoboxValidatorParams params)
    throws ValidateException;

}