1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 // IXmlFileInputValidator

    15 //

    16 

    17 

    18 

    19 package com.symbian.smt.gui.smtwidgets;

    20 

    21 /**

    22  * This is an extension of the IFileInputValidator interface which caters for

    23  * validation of XML files

    24  * 

    25  * @author barbararosi-schwartz

    26  * 

    27  */

    28 public interface IXmlFileInputValidator extends IFileInputValidator {

    29 	

    30 	/**

    31 	 * Determines whether or not the file identified by the provided path

    32 	 * is a valid XML resource. Returns a message to display if validation 

    33 	 * fails.

    34 	 * <p>

    35 	 * Returns <code>null</code> if validation succeeds.

    36 	 * <p>

    37 	 * The unconventional method signature follows the pattern of 

    38 	 * IInputValidator's isValid() method.

    39 	 * 

    40 	 * @param filePath

    41 	 *            the String representing the path to the file to

    42 	 *            be validated.

    43 	 * 

    44 	 * @return a message or <code>null</code> if no validation error

    45 	 */

    46 	public String isXmlValid(String filePath);

    47 }