com.sap.netweaver.bc.uwl.config

Class UWLSortGroup

java.lang.Object
  com.sap.netweaver.bc.uwl.config.UWLSortGroup

All Implemented Interfaces:

Serializable, Cloneable

public class UWLSortGroup
extends Object
implements Cloneable, Serializable

See Also:

Serialized Form

Field Summary

static String	ASCENDING Comment for ASCENDING
static String	DESCENDING Comment for DESCENDING

Constructor Summary

UWLSortGroup(String id, String sortAttributeName, String sortDirection)

UWLSortGroup(String id, String sortAttributeName, String sortDirection, String refBundle, Descriptions descriptions)

Method Summary

void	addSecondarySortGroup(UWLSortGroup sortGroup)
Object	clone()
Descriptions	getDescriptions()
String	getId()
String	getLongText(Locale locale) Get the long text for the specified locale.
String	getReferenceBundle() Used internally to set DisplayName in the xml file
UWLSortGroup[]	getSecondarySortGroups()
String	getShortText(Locale locale) Return the action display name text for the specified Locale.
String	getSortAttributeName()
String	getSortDirection()
boolean	isAscending()
void	setDescriptions(Descriptions descriptions)
void	setReferenceBundle(String ref)
void	setSecondarySortGroups(UWLSortGroup[] sortGroup)
void	setSortDirection(String sortDirection)

Methods inherited from class java.lang.Object

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

Field Detail

ASCENDING

public static final String ASCENDING

Comment for ASCENDING

See Also:

Constant Field Values

DESCENDING

public static final String DESCENDING

Comment for DESCENDING

See Also:

Constant Field Values

Constructor Detail

UWLSortGroup

public UWLSortGroup(String id,
                    String sortAttributeName,
                    String sortDirection)

Parameters:

id -

sortAttributeName -

sortDirection -

UWLSortGroup

public UWLSortGroup(String id,
                    String sortAttributeName,
                    String sortDirection,
                    String refBundle,
                    Descriptions descriptions)

Parameters:

id -

sortAttributeName -

sortDirection -

refBundle -

descriptions -

Method Detail

getShortText

public String getShortText(Locale locale)

Return the action display name text for the specified Locale.

Parameters:

locale -

Returns:

None NULL string will be returned. If the desired Text is not found then an empty string is returned.

getLongText

public String getLongText(Locale locale)

Get the long text for the specified locale. This is the Text used to create the tooltip.

Parameters:

locale -

Returns:

None NULL string will be returned. If the desired Text is not found then an empty string is returned.

getReferenceBundle

public String getReferenceBundle()

Used internally to set DisplayName in the xml file

Returns:

setReferenceBundle

public void setReferenceBundle(String ref)

Parameters:

ref -

getDescriptions

public Descriptions getDescriptions()

Returns:

Returns the descriptions.

setDescriptions

public void setDescriptions(Descriptions descriptions)

Parameters:

descriptions - The descriptions to set.

getSortDirection

public String getSortDirection()

Returns:

Returns the sortDirection.

isAscending

public boolean isAscending()

Returns:

setSortDirection

public void setSortDirection(String sortDirection)

Parameters:

sortDirection - The sortDirection to set.

getSortAttributeName

public String getSortAttributeName()

Returns:

Returns the sortAttributeName.

getSecondarySortGroups

public UWLSortGroup[] getSecondarySortGroups()

Returns:

Returns the secondarySortGroups.

setSecondarySortGroups

public void setSecondarySortGroups(UWLSortGroup[] sortGroup)

Parameters:

sortGroup -

addSecondarySortGroup

public void addSecondarySortGroup(UWLSortGroup sortGroup)

Parameters:

sortGroup -

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getId

public String getId()

Returns:

Returns the id.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	default	EP-BC-UWL
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	-	EP-BC-UWL