com.sapportals.wcm.service.propertyconfig.comparator

Interface IResourcePropertyComparator

All Superinterfaces:

Comparator

All Known Implementing Classes:

DefaultResourcePropertyComparator, PropertyLanguageDependingComparator

public interface IResourcePropertyComparator

extends Comparator

Comparator interface that must be implemented when implementing resource property comparators that are defined as property meta data in the property configuration service.

Method Summary

int	getSortMode() Current sort mode for sorting resource properties.
IMetaName	getSortPropertyName() Name of the property that is used for sorting.
void	setSortMode(int sortMode) Determines the sort mode of the resource properties.
void	setSortParameters(IMetaName sortPropertyName, int sortMode) Name of the property that is used for sorting and the default sort mode.

Methods inherited from interface java.util.Comparator

compare, equals

Method Detail

setSortMode

public void setSortMode(int sortMode)
                 throws PropertyConfigurationServiceException

Determines the sort mode of the resource properties. Use constants IMetaName.SORTMODE_ASCENDING and IMetaName.SORTMODE_DESCENDING. Default is defined in the meta data of the property.

Parameters:

sortMode - order of sorting for property values

Throws:

PropertyConfigurationServiceException

getSortMode

public int getSortMode()

Current sort mode for sorting resource properties. Compare with constants IMetaName.SORTMODE_ASCENDING and IMetaName.SORTMODE_DESCENDING

Returns:

sort mode of the comparator

getSortPropertyName

public IMetaName getSortPropertyName()

Name of the property that is used for sorting.

Returns:

property name for sorting

setSortParameters

public void setSortParameters(IMetaName sortPropertyName,
                              int sortMode)
                       throws PropertyConfigurationServiceException

Name of the property that is used for sorting and the default sort mode. The parameters are set internally by the property configuration service.

Parameters:

sortPropertyName - property name for sorting

sortMode - order of sorting for property values

Throws:

PropertyConfigurationServiceException