com.sapportals.wcm.service.propertyconfig.metadataextension

Class DefaultMetadataExtension

java.lang.Object
  com.sapportals.wcm.service.propertyconfig.metadataextension.DefaultMetadataExtension

All Implemented Interfaces:

IDynamicValues, IValidation

public class DefaultMetadataExtension
extends Object
implements IDynamicValues, IValidation

Default implementation of a metadata extension.

Field Summary

protected IMetaModel

model

Constructor Summary

DefaultMetadataExtension(IMetaModel model)

Method Summary

IMetaValueList	getAllowedValues(IMetaName metaName) Returns allowed values depending on the meta name.
IMetaValueList	getAllowedValues(IMetaName metaName, IMetaContext metaContext) Returns allowed values depending on the meta name.
IMetaValue	getDefaultValue(IMetaName metaName) Returns a default value depending on the meta name.
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	getPropertyDescription(IMetaName metaName, Locale locale) Gets a description for a property depending on the input locale.
String	getPropertyLabel(IMetaName metaName, Locale locale) Gets a label for the property name depending on the input locale.
String	getValidationInstanceID() The validation instance ID is used as a namespace for the error IDs the are returned.
String	getValueLabel(IMetaValue metaValue, Locale locale) Gets a label for a property value depending on the input locale.
IMetaValue	searchMetaValue(String value) Returns a meta value by its ID (property value ID).
IValidationErrorList	validate(IMetaName metaName, IProperty property, IMetaContext metaContext) Validation of properties via predefined validation classes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

model

protected IMetaModel model

Constructor Detail

DefaultMetadataExtension

public DefaultMetadataExtension(IMetaModel model)

Parameters:

model - meta model

Method Detail

getAllowedValues

public IMetaValueList getAllowedValues(IMetaName metaName)
                                throws PropertyConfigurationServiceException

Returns allowed values depending on the meta name.

Specified by:

getAllowedValues in interface IDynamicValues

Parameters:

metaName - meta model information of a property

Returns:

list of relevant values (incl. empty list) or null if there is no value domain

Throws:

PropertyConfigurationServiceException

getAllowedValues

public IMetaValueList getAllowedValues(IMetaName metaName,
                                       IMetaContext metaContext)
                                throws PropertyConfigurationServiceException

Returns allowed values depending on the meta name.

Specified by:

getAllowedValues in interface IDynamicValues

Parameters:

metaName - meta model information of a property

metaContext - context information

Returns:

list of relevant values (incl. empty list) or null if there is no value domain

Throws:

PropertyConfigurationServiceException

getValueLabel

public String getValueLabel(IMetaValue metaValue,
                            Locale locale)
                     throws PropertyConfigurationServiceException

Gets a label for a property value depending on the input locale.

Specified by:

getValueLabel in interface IDynamicValues

Parameters:

metaValue - metaValue for that a label is requested

locale - locale to determine the lable language

Returns:

label for a property value, return null if no lable can be found for the value

Throws:

PropertyConfigurationServiceException

getDefaultValue

public IMetaValue getDefaultValue(IMetaName metaName)

Returns a default value depending on the meta name.

Specified by:

getDefaultValue in interface IDynamicValues

Parameters:

metaName - meta model information of a property

Returns:

default value or null

getPropertyLabel

public String getPropertyLabel(IMetaName metaName,
                               Locale locale)
                        throws PropertyConfigurationServiceException

Gets a label for the property name depending on the input locale.

Specified by:

getPropertyLabel in interface IDynamicValues

Parameters:

metaName - meta name for that the label is requested

locale - locale to determine the lable language

Returns:

label for a property name, returns null if no label can be found for the name

Throws:

PropertyConfigurationServiceException

getPropertyDescription

public String getPropertyDescription(IMetaName metaName,
                                     Locale locale)
                              throws PropertyConfigurationServiceException

Gets a description for a property depending on the input locale.

Specified by:

getPropertyDescription in interface IDynamicValues

Parameters:

metaName - meta name for that the description is requested

locale - locale to determine the description language

Returns:

description for a property, returns null if no description can be found for the property

Throws:

PropertyConfigurationServiceException

validate

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

Validation of properties via predefined validation classes

Specified by:

validate in interface IValidation

Parameters:

metaName - meta model information of a property

property - property to validate

metaContext - context information

Returns:

list of validation errors, null if no error occured

Throws:

PropertyConfigurationServiceException

getErrorMessage

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

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

Specified by:

getErrorMessage in interface IValidation

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

getValidationInstanceID

public String getValidationInstanceID()

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

Specified by:

getValidationInstanceID in interface IValidation

Returns:

ID/Namespace of the validation instance

searchMetaValue

public IMetaValue searchMetaValue(String value)
                           throws PropertyConfigurationServiceException

Returns a meta value by its ID (property value ID). Returns null if the value provider doesn't know the property value.

Specified by:

searchMetaValue in interface IDynamicValues

Parameters:

value - property value

Returns:

<{IMetaValue}> (0, 1)

Throws:

PropertyConfigurationServiceException

getErrorMessage

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

Specified by:

getErrorMessage in interface IValidation

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

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