com.sapportals.wcm.service.propertyconfig.metadataextension

Interface IValidationError


public interface IValidationError

Error that occured during the validation of a property value


Method Summary
 Map getAdditionalInfo()
          Gets additional information about the validation error.
 String getErrorID()
          Gets the error ID.
 String getErrorMessage(Locale locale)
          Localized error message that describes the error including information about the properties that caused the error.
 IMetaNameList getMetaNames()
          Meta names that caused the validation error.
 String getUniqueErrorID()
          Creates a unique error ID by concatenating the validation instance ID and the error ID.
 void setAdditionalInfo(Map additionalInfo)
          Sets additional information for a validation error.
 

Method Detail

getMetaNames

public IMetaNameList getMetaNames()
Meta names that caused the validation error.

Returns:
list of meta names where the error occured

getErrorMessage

public String getErrorMessage(Locale locale)
                       throws PropertyConfigurationServiceException
Localized error message that describes the error including information about the properties that caused the error.

Returns:
localized error message
Throws:
PropertyConfigurationServiceException

getErrorID

public String getErrorID()
Gets the error ID.

Returns:
ID of the error

getUniqueErrorID

public String getUniqueErrorID()
Creates a unique error ID by concatenating the validation instance ID and the error ID.

Returns:
unique error ID

setAdditionalInfo

public void setAdditionalInfo(Map additionalInfo)
Sets additional information for a validation error. As an example one could set the property ID as key and a list of wrong values as value.

Parameters:
additionalInfo - map with additional information

getAdditionalInfo

public Map getAdditionalInfo()
Gets additional information about the validation error. The validation instance must have set this map before.

Returns:
map with additional information


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.