com.ptc.windchill.enterprise.search.server
Class SearchPreferencesHelper

java.lang.Object
  com.ptc.windchill.enterprise.search.server.SearchPreferencesHelper

All Implemented Interfaces:

Externalizable, RemoteAccess, Serializable

public final class SearchPreferencesHelper

extends Object

implements RemoteAccess, Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private static String	FC_RESOURCE
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
(package private) static boolean	SERVER
private static boolean	VERBOSE

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

SearchPreferencesHelper()

Method Summary

protected static String	_getPreferenceValue(String node, String key) Returns a preference value given the node and key.
protected static String[]	_getPreferenceValueAsList(String node, String key, String delim) Returns a preference value given the node and key.
static String	getPreferenceValue(String node, String key) Returns a preference value given the node and key.
static String	getPreferenceValue(String node, String key, String aContainer) Gets a Preference value based on the node, key and specified container Supported API: false
static String	getPreferenceValue(String key, WTPreferences pref) This function is a helper to get a preference based on a key and an already defined WTPreference Supported API: false
static String[]	getPreferenceValueAsList(String node, String key, String delim) Returns a preference value given the node and key.
static String[]	getPreferenceValueAsList(String node, String key, String delim, String aContainer) Returns a preference value given the node and key.
static String[]	getPreferenceValueAsList(String key, String delim, WTPreferences pref) Returns a preference value given the node and key.
static String[]	getSearchableTypesFromPrefsByContainer(String aContainer) Supported API: false
static TypeIdentifier[]	getTypeIdentifiersFromStrings(String[] prefsTypeList)
static void	main(String[] args)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(SearchPreferencesHelper thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
static void	setPreferenceValue(String node, String key, String value) Stores a preference value given the node and key.
static void	setPreferenceValue(String key, String value, WTPreferences pref) Stores a preference value given the key, value and an already defined WTPreferences.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

SERVER

static final boolean SERVER

FC_RESOURCE

private static final String FC_RESOURCE

See Also:

Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

VERBOSE

private static final boolean VERBOSE

See Also:

Constant Field Values

Constructor Detail

SearchPreferencesHelper

public SearchPreferencesHelper()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(SearchPreferencesHelper thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getPreferenceValue

public static String getPreferenceValue(String node,
                                        String key)
                                 throws WTException

Returns a preference value given the node and key.

Supported API: false

Parameters:

node -

key -

Returns:

String

Throws:

WTException

_getPreferenceValue

protected static String _getPreferenceValue(String node,
                                            String key)
                                     throws WTException

Returns a preference value given the node and key.

Supported API: false

Parameters:

node -

key -

Returns:

String

Throws:

WTException

getPreferenceValueAsList

public static String[] getPreferenceValueAsList(String node,
                                                String key,
                                                String delim)
                                         throws WTException

Returns a preference value given the node and key.

Supported API: false

Parameters:

node -

key -

delim -

Returns:

String[]

Throws:

WTException

_getPreferenceValueAsList

protected static String[] _getPreferenceValueAsList(String node,
                                                    String key,
                                                    String delim)
                                             throws WTException

Returns a preference value given the node and key.

Supported API: false

Parameters:

node -

key -

delim -

Returns:

String[]

Throws:

WTException

setPreferenceValue

public static void setPreferenceValue(String node,
                                      String key,
                                      String value)
                               throws WTException

Stores a preference value given the node and key.

Supported API: false

Parameters:

node -

key -

value -

Throws:

WTException

getPreferenceValue

public static String getPreferenceValue(String node,
                                        String key,
                                        String aContainer)
                                 throws WTException

Gets a Preference value based on the node, key and specified container

Supported API: false

Parameters:

node -

key -

aContainer -

Returns:

String

Throws:

WTException

getPreferenceValueAsList

public static String[] getPreferenceValueAsList(String node,
                                                String key,
                                                String delim,
                                                String aContainer)
                                         throws WTException

Returns a preference value given the node and key.

Supported API: false

Parameters:

node -

key -

delim -

aContainer -

Returns:

String[]

Throws:

WTException

getSearchableTypesFromPrefsByContainer

public static String[] getSearchableTypesFromPrefsByContainer(String aContainer)
                                                       throws WTException

Supported API: false

Parameters:

aContainer -

Returns:

String[]

Throws:

WTException

setPreferenceValue

public static void setPreferenceValue(String key,
                                      String value,
                                      WTPreferences pref)
                               throws WTException

Stores a preference value given the key, value and an already defined WTPreferences.

Supported API: false

Parameters:

key -

value -

pref -

Throws:

WTException

getPreferenceValue

public static String getPreferenceValue(String key,
                                        WTPreferences pref)
                                 throws WTException

This function is a helper to get a preference based on a key and an already defined WTPreference

Supported API: false

Parameters:

pref -

Returns:

String

Throws:

WTException

getPreferenceValueAsList

public static String[] getPreferenceValueAsList(String key,
                                                String delim,
                                                WTPreferences pref)
                                         throws WTException

Returns a preference value given the node and key.

Supported API: false

Parameters:

key -

delim -

Returns:

String[]

Throws:

WTException

getTypeIdentifiersFromStrings

public static TypeIdentifier[] getTypeIdentifiersFromStrings(String[] prefsTypeList)
                                                      throws WTException

Throws:

WTException

main

public static void main(String[] args)