com.sapportals.wcm.repository.service.layout.customizing.flavor

Interface IFlavorProperty

public interface IFlavorProperty

Defines a Property for a context. It consists of a FlavorPropertyDef and a value. All FlavorProperties can be sorted by the rank of their FlavorPropertyDefs.

Field Summary

static String	NOVALUE
static String	WILDCARD

Method Summary

int	compareWeight(IFlavorProperty impValue) Compares the weight of the current FlavorProperty with the impProperty.
IFlavorPropertyDef	getDef()
String	getValue()
boolean	isNoValue()
boolean	isWildcard()
boolean	matches(IFlavorProperty impValue) Compares the values of two context properties.

Field Detail

WILDCARD

static final String WILDCARD

See Also:

Constant Field Values

NOVALUE

static final String NOVALUE

See Also:

Constant Field Values

Method Detail

matches

boolean matches(IFlavorProperty impValue)

Compares the values of two context properties. Returns zero, if the two values are equal. If the values are not equal and this context properties value is not the NOVALUE and the others is not the WILDCARD a positive integer is returned, otherwise a negative integer is returned.

Parameters:

impProperty - the context property to compare with

Returns:

a negative integer, zero, or a positive integer depending on the values

Throws:

a - FlavorException when the property definitions are not equal

compareWeight

int compareWeight(IFlavorProperty impValue)

Compares the weight of the current FlavorProperty with the impProperty. When the values are not equal, the weight of the values are compared. The weight of the WILDCARD is higher as the weight of a normal value, and that is higher than the weight of the NOVALUE

Parameters:

impProperty - the context property to compare with

Returns:

a negative integer, zero, or a positive integer depending on the weight of the values

Throws:

a - FlavorException when the property definitions are not equal

getValue

String getValue()

isNoValue

boolean isNoValue()

isWildcard

boolean isWildcard()

getDef

IFlavorPropertyDef getDef()

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