com.liferay.portal.odata.sort

Class SortField

java.lang.Object

com.liferay.portal.odata.sort.SortField

All Implemented Interfaces:

java.io.Serializable

public class SortField
extends java.lang.Object
implements java.io.Serializable

Models a sort field.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SortField(EntityField entityField, boolean asc) Creates a new sort field.
SortField(java.lang.String fieldName, boolean asc) Creates a new sort field not linked to a entityField

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSortableFieldName(java.util.Locale locale) Returns the field's name.
boolean	isAscending() Returns true if the sort field is ascending.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SortField

public SortField(EntityField entityField,
                 boolean asc)

Creates a new sort field.

Parameters:

entityField - the entity field

asc - whether the sort should be ascending

SortField

public SortField(java.lang.String fieldName,
                 boolean asc)

Creates a new sort field not linked to a entityField

Parameters:

fieldName - the entity field name

asc - whether the sort should be ascending

Method Detail

getSortableFieldName

public java.lang.String getSortableFieldName(java.util.Locale locale)

Returns the field's name.

Parameters:

locale - the locale

Returns:

the field's name

isAscending

public boolean isAscending()

Returns true if the sort field is ascending.

Returns:

true if the sort field is ascending; false otherwise