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

IMetaNameList getMetaNames()

Meta names that caused the validation error.

Returns:

list of meta names where the error occured

getErrorMessage

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

String getErrorID()

Gets the error ID.

Returns:

ID of the error

getUniqueErrorID

String getUniqueErrorID()

Creates a unique error ID by concatenating the validation instance ID and the error ID.

Returns:

unique error ID

setAdditionalInfo

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

Map getAdditionalInfo()

Gets additional information about the validation error. The validation instance must have set this map before.

Returns:

map with additional information

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM