SAP NetWeaver '04

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

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar]
java.lang.Object
  |
  +--com.sapportals.wcm.service.indexmanagement.retrieval.search.SortPropertyName
All Implemented Interfaces:
IName, IPropertyName, ISortPropertyName

public class SortPropertyName
extends java.lang.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.


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)
           
 
Method Summary
 boolean equals(java.lang.Object other)
           
 java.lang.String getName()
          Returns the local name.
 java.lang.String getNamespace()
          Returns the namespace URI (a missing namespace is mapped to an empty string).
 java.lang.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()
           
 java.lang.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 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 java.lang.String getNamespace()
Returns the namespace URI (a missing namespace is mapped to an empty string).
Specified by:
getNamespace in interface IName
Following copied from interface: com.sapportals.wcm.util.name.IName
Returns:
namespace

getNamespaceOrNull

public java.lang.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 IName
Following copied from interface: com.sapportals.wcm.util.name.IName
Returns:
namespaceOrNull

getName

public java.lang.String getName()
Returns the local name.
Specified by:
getName in interface IName
Following copied from interface: com.sapportals.wcm.util.name.IName
Returns:
name

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class java.lang.Object

hashCode

public final int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public final java.lang.String toString()
Overrides:
toString in class java.lang.Object

getPropertyNameObject

public IPropertyName getPropertyNameObject()
Description copied from interface: ISortPropertyName
Returns the internal IPropertyName object.
Specified by:
getPropertyNameObject in interface ISortPropertyName
Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.ISortPropertyName
Returns:
property name

SAP NetWeaver '04

Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.