com.sapportals.wcm.service.indexmanagement.retrieval.search

Class SortPropertyName

java.lang.Object
  com.sapportals.wcm.service.indexmanagement.retrieval.search.SortPropertyName

All Implemented Interfaces:

IPropertyName, ISortPropertyName, com.sapportals.wcm.util.name.IName

public class SortPropertyName
extends Object
implements ISortPropertyName, IPropertyName

A sort property name is a combination of a resource property name and a sort direction.
It is used for sorting documents by one of their properties.

Field Summary

Fields inherited from interface com.sapportals.wcm.service.indexmanagement.retrieval.search.ISortPropertyName

SORT_ASCENDING, SORT_DESCENDING

Constructor Summary

SortPropertyName(IPropertyName propertyName, PropertyType propertyType, boolean sortDirection)
Creates a sort property from a property name.

Method Summary

boolean	equals(Object other)
String	getName() Returns the local name.
String	getNamespace() Returns the namespace URI (a missing namespace is mapped to an empty string).
String	getNamespaceOrNull() Returns the namespace URI (a missing namespace is mapped to null).
IPropertyName	getPropertyNameObject() Returns the internal IPropertyName object.
PropertyType	getPropertyType()
boolean	getSortDirection()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SortPropertyName

public SortPropertyName(IPropertyName propertyName,
                        PropertyType propertyType,
                        boolean sortDirection)
                 throws com.sapportals.wcm.WcmException

Creates a sort property from a property name. As far as it is known the property type is not needed and never used somewhere else.

Parameters:

propertyName -

propertyType -

sortDirection -

Throws:

com.sapportals.wcm.WcmException

Method Detail

getSortDirection

public boolean getSortDirection()

Specified by:

getSortDirection in interface ISortPropertyName

Returns:

if true sort direction is ascending, if false sort direction is descending

getPropertyType

public PropertyType getPropertyType()

Specified by:

getPropertyType in interface ISortPropertyName

Returns:

type of the property

getNamespace

public String getNamespace()

Returns the namespace URI (a missing namespace is mapped to an empty string).

Specified by:

getNamespace in interface com.sapportals.wcm.util.name.IName

getNamespaceOrNull

public String getNamespaceOrNull()

Returns the namespace URI (a missing namespace is mapped to null). Use this function if the value is going to be passed to a XML DOM level 2 method.

Specified by:

getNamespaceOrNull in interface com.sapportals.wcm.util.name.IName

getName

public String getName()

Returns the local name.

Specified by:

getName in interface com.sapportals.wcm.util.name.IName

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object

getPropertyNameObject

public IPropertyName getPropertyNameObject()

Description copied from interface: ISortPropertyName

Returns the internal IPropertyName object.

Specified by:

getPropertyNameObject in interface ISortPropertyName

Returns:

property name

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