com.sapportals.wcm.service.propertyconfig.metadataextension

Interface IValidation

All Known Implementing Classes:

DefaultMetadataExtension

public interface IValidation

Validation of property values.

Method Summary

String	getErrorMessage(String errorID, IMetaNameList metaNames, Locale locale) Deprecated. since EP6 SP2 FP, use getErrorMessage(String,IMetaNameList,Locale,Map)
String	getErrorMessage(String errorID, IMetaNameList metaNames, Locale locale, Map additionalInfo)
String	getValidationInstanceID() The validation instance ID is used as a namespace for the error IDs the are returned.
IValidationErrorList	validate(IMetaName metaName, IProperty property, IMetaContext metaContext) Validation of properties via predefined validation classes

Method Detail

validate

IValidationErrorList validate(IMetaName metaName,
                              IProperty property,
                              IMetaContext metaContext)
                              throws PropertyConfigurationServiceException

Validation of properties via predefined validation classes

Parameters:

metaName - meta model information of a property

properties - list of properties to validate

metadataContext - context information. Can be null if no context information is provided by the calling UI.

Returns:

list of validation errors, null if no error occured

Throws:

PropertyConfigurationServiceException

getErrorMessage

String getErrorMessage(String errorID,
                       IMetaNameList metaNames,
                       Locale locale)
                       throws PropertyConfigurationServiceException

Deprecated. since EP6 SP2 FP, use getErrorMessage(String,IMetaNameList,Locale,Map)

Parameters:

errorID - validation error ID

metaNames - list of meta names that caused the error

locale - locale to determine the message language

Returns:

error message in the locales language

Throws:

PropertyConfigurationServiceException

getErrorMessage

String getErrorMessage(String errorID,
                       IMetaNameList metaNames,
                       Locale locale,
                       Map additionalInfo)
                       throws PropertyConfigurationServiceException

Parameters:

errorID - validation error ID

metaNames - list of meta names that caused the error

locale - locale to determine the message language

additionalInfo - map with additional information about the error; can be null

Returns:

error message in the locales language

Throws:

PropertyConfigurationServiceException

getValidationInstanceID

String getValidationInstanceID()

The validation instance ID is used as a namespace for the error IDs the are returned.

Returns:

ID/Namespace of the validation instance

Access Rights

This class can be accessed from:

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