sysmodelmgr/com.symbian.smt.gui/src/com/symbian/smt/gui/smtwidgets/IXmlFileInputValidator.java
author terytkon
Thu, 11 Mar 2010 19:08:43 +0200
changeset 0 522a326673b6
permissions -rw-r--r--
Moved swconfigapps content under oss repository.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     2
// All rights reserved.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     3
// This component and the accompanying materials are made available
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     5
// which accompanies this distribution, and is available
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     7
//
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     8
// Initial Contributors:
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    10
//
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    11
// Contributors:
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    12
//
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    13
// Description:
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    14
// IXmlFileInputValidator
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    15
//
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    16
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    17
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    18
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    19
package com.symbian.smt.gui.smtwidgets;
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    20
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    21
/**
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    22
 * This is an extension of the IFileInputValidator interface which caters for
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    23
 * validation of XML files
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    24
 * 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    25
 * @author barbararosi-schwartz
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    26
 * 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    27
 */
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    28
public interface IXmlFileInputValidator extends IFileInputValidator {
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    29
	
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    30
	/**
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    31
	 * Determines whether or not the file identified by the provided path
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    32
	 * is a valid XML resource. Returns a message to display if validation 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    33
	 * fails.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    34
	 * <p>
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    35
	 * Returns <code>null</code> if validation succeeds.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    36
	 * <p>
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    37
	 * The unconventional method signature follows the pattern of 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    38
	 * IInputValidator's isValid() method.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    39
	 * 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    40
	 * @param filePath
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    41
	 *            the String representing the path to the file to
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    42
	 *            be validated.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    43
	 * 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    44
	 * @return a message or <code>null</code> if no validation error
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    45
	 */
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    46
	public String isXmlValid(String filePath);
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    47
}