com.sapportals.wcm.service.propertyconfig.metadataextension
Interface IDynamicValues

[contained in: com.sap.km.cm.service.base.par - km.shared.service.propertyconfig_api.jar]

All Known Implementing Classes:

DefaultMetadataExtension

public interface IDynamicValues

Providing values for properties.

Method Summary

IMetaValueList	getAllowedValues(IMetaName metaName) Returns values depending on the meta name.
IMetaValueList	getAllowedValues(IMetaName metaName, IMetaContext metaContext) Returns values depending on the meta name and the resource.
IMetaValue	getDefaultValue(IMetaName metaName) Returns a default value depending on the meta name.
java.lang.String	getPropertyDescription(IMetaName metaName, java.util.Locale locale) Gets a description for a property depending on the input locale.
java.lang.String	getPropertyLabel(IMetaName metaName, java.util.Locale locale) Gets a label for the property name depending on the input locale.
java.lang.String	getValueLabel(IMetaValue metaValue, java.util.Locale locale) Gets a label for a property value depending on the input locale.
IMetaValue	searchMetaValue(java.lang.String value) Returns a meta value by its ID (property value ID).

Method Detail

getValueLabel

public java.lang.String getValueLabel(IMetaValue metaValue,
                                      java.util.Locale locale)
                               throws PropertyConfigurationServiceException

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

Parameters:

metaValue - metaValue for that a label is requested

locale - locale to determine the lable language

Returns:

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

getAllowedValues

public IMetaValueList getAllowedValues(IMetaName metaName)
                                throws PropertyConfigurationServiceException

Returns values depending on the meta name.

Parameters:

metaName - meta model information of a property

Returns:

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

getAllowedValues

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

Returns values depending on the meta name and the resource.

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

getDefaultValue

public IMetaValue getDefaultValue(IMetaName metaName)

Returns a default value depending on the meta name.

Parameters:

metaName - meta model information of a property

Returns:

default value or null

getPropertyLabel

public java.lang.String getPropertyLabel(IMetaName metaName,
                                         java.util.Locale locale)
                                  throws PropertyConfigurationServiceException

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

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

getPropertyDescription

public java.lang.String getPropertyDescription(IMetaName metaName,
                                               java.util.Locale locale)
                                        throws PropertyConfigurationServiceException

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

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

searchMetaValue

public IMetaValue searchMetaValue(java.lang.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.

Parameters:

value - property value

Returns:

<{IMetaValue}> (0, 1)