com.sap.mdm.data
Class SortDefinition

java.lang.Object
  extended bycom.sap.mdm.data.SortDefinition

public class SortDefinition
extends Object

This class includes information how the records retrieved from repository should be sorted in result set.

See Also:
ResultSet

Constructor Summary
SortDefinition()
          Empty constructor
SortDefinition(SortField sortField)
          Defines the field to sort by.
 
Method Summary
 void addSortField(FieldId fieldId, boolean isAscending)
          Add sorting field ID to Sort definition
 FieldId[] getSortFields()
          Get array of sorting fields
 SortField[] getSorting()
          Returns a list of fields to sort by.
 boolean isSortAscending(FieldId fieldId)
          Specify if sorting of given sorting field is ascending
 void removeSortField(FieldId fieldId)
          Remove sorting field ID from Sort definition
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SortDefinition

public SortDefinition()
Empty constructor


SortDefinition

public SortDefinition(SortField sortField)
Defines the field to sort by.

Parameters:
sortField - the field to sort by
Since:
7.1 SP08
Method Detail

addSortField

public void addSortField(FieldId fieldId,
                         boolean isAscending)
Add sorting field ID to Sort definition

Parameters:
fieldId - sorting field ID
isAscending - parameter specifying if sorting is ascending

removeSortField

public void removeSortField(FieldId fieldId)
Remove sorting field ID from Sort definition

Parameters:
fieldId - sorting field ID that should be removed

getSortFields

public FieldId[] getSortFields()
Get array of sorting fields

Returns:
array of FieldId

getSorting

public SortField[] getSorting()
Returns a list of fields to sort by.

Returns:
The sort fields.
Since:
7.1 SP08

isSortAscending

public boolean isSortAscending(FieldId fieldId)
                        throws IllegalArgumentException
Specify if sorting of given sorting field is ascending

Parameters:
fieldId - the field to sort by
Returns:
true if sorting is ascending, false otherwise
Throws:
IllegalArgumentException - if specified fieldId was not added to sort definition


Copyright 2004-2007 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.