wt.org
Class PrincipalCollationKeyFactory

java.lang.Object
  wt.util.CollationKeyFactory
      wt.org.PrincipalCollationKeyFactory

public final class PrincipalCollationKeyFactory

extends CollationKeyFactory

A collation key factory for Principals

Supported API: true
Extendable: false

Field Summary

private static boolean	DISPLAY_FULLNAME
private static boolean	DISPLAY_NAME_AND_FULLNAME
private boolean	displayOption
private String	securedInfo

Fields inherited from class wt.util.CollationKeyFactory

Constructor Summary

PrincipalCollationKeyFactory()
Construct a collation key factory for the current WTContext's locale.

PrincipalCollationKeyFactory(Locale locale)
Construct a collation key factory for the given locale.

Method Summary

String	getCollationString(Object obj) Get a collation string for the given object.
void	setDisplayOption(boolean display_option) Set display option for users or references to users.

Methods inherited from class wt.util.CollationKeyFactory

getKey, getLocale

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_FULLNAME

private static final boolean DISPLAY_FULLNAME

See Also:

Constant Field Values

DISPLAY_NAME_AND_FULLNAME

private static final boolean DISPLAY_NAME_AND_FULLNAME

See Also:

Constant Field Values

displayOption

private boolean displayOption

securedInfo

private String securedInfo

Constructor Detail

PrincipalCollationKeyFactory

public PrincipalCollationKeyFactory()

Construct a collation key factory for the current WTContext's locale.

Supported API: true
Extendable: false

PrincipalCollationKeyFactory

public PrincipalCollationKeyFactory(Locale locale)

Construct a collation key factory for the given locale.

Parameters:

locale - desired locale

Supported API: true
Extendable: false

Method Detail

setDisplayOption

public void setDisplayOption(boolean display_option)

Set display option for users or references to users.

Parameters:

display_option - true if display of users should include name in addition to full name

Supported API: false

getCollationString

public String getCollationString(Object obj)

Get a collation string for the given object. Principals will be sorted by name.

Overrides:

getCollationString in class CollationKeyFactory

Parameters:

obj - the object that will be part of the sorted results

Supported API: true
Extendable: false

Returns:

string collation key source string