PreferenceHelperService (WNC.X-05.0.0.00.73)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

wt.prefs
Class PreferenceHelperService

java.lang.Object
  wt.prefs.PreferenceHelperService

All Implemented Interfaces:: RemoteAccess

public final class PreferenceHelperService
extends Object
implements RemoteAccess

The PreferenceHelperService is the server-side Helper for the Preferences Framework and is responsible for the maintaining of the Delegate Heirarchy and Delegate list in Windchill.

The public methods contained in this class should not be called directly, but instead should be called from the wt.prefs.PreferenceHelper class.

This class will on the server-side of any RMI calls where necessary, and will work properly only on the server environment due to server-side dependencies.

Supported API: false

See Also:: PreferenceHelper, WTPreferences, PreferenceDelegate, UserDelegate

Nested Class Summary
`private static class`	`PreferenceHelperService.PrefCacheKey`

Field Summary
`private static Cache`	`cache`
`private static int`	`cacheSize`
`private static List`	`cvDelegateHeirarchy` List of all DelegateStructures for initialized delegates
`private static String`	`cvDelegateList` The most recently obtained heirarchy list from delegates.properties
`private static Hashtable`	`cvDelegates` The hashtable of all Delegates
`private static long`	`cvLastUpdate` Get the last update of the delegate orders
`private static String`	`DEF_CONTAINER_DEL` Default container delegate class.
`private static long`	`TIME_OUT` Timeout for properties refresh
`private static boolean`	`VERBOSE`

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary
`PreferenceHelperService()`

Method Summary
`static String[]`	`createContextMask(String division)` This method will create a Context Mask for the current logged in user.
`static String[]`	`createContextMask(String aContainer, String division)` This method will create a Context Mask for the current logged in user.
`static String[]`	`createContextMask(String aDivision, WTUser aUser)` This method will create a Context Mask for the named user.
`static String[]`	`createContextMask(WTContainerRef aContainer, String aDivision, WTUser aUser)` This method will create a Context Mask for the named user.
`static String`	`createEditMask()` This method will attempt to create the Edit Mask for the current user.
`static String`	`createEditMask(String division, Boolean apolicy)` This method will attempt to create the Edit Mask for the current user at a given division node in the Heirarchy.
`static String`	`createEditMask(String division, WTUser aUser, Boolean apolicy)` This method will attempt to create the Edit Mask for a given user at a given division node in the Heirarchy.
`static String`	`createEditMask(WTContainerRef aContainer, WTUser aUser, Boolean apolicy)` This method will attempt to create the Edit Mask for a given user at a given container level in the Heirarchy.
`private static PreferenceDelegate`	`getDelegate(String delegate_tag)` This method will return a `PreferenceDelegate` that is assigned as the delegate for a specific delegate tag.
`private static void`	`getDelegateHeirarchy()` This method will access the Preferences Framework and will create a heirarchial list of PreferenceDelegates as defined in the Property `wt.prefs.delegates.DelegateOrder in the delegates.properties file.`
`static String`	`getDisplayNameFromContext(String aContext, Locale aLocale)` This method will access the delegate for the given context and return the localized string the represents that context within the delegate.
`static String[]`	`getDivisionsAsAdministrator()` This method will return the divisions that the user can administer from the current sesssion context.
`static String[]`	`getDivisionsAsAdministrator(String aContainer)` This method will return the divisions that the named user can administer from the list of all the delegates in the current heirarchy.
`static String[]`	`getDivisionsAsAdministrator(WTContainerRef aContainer)` This method will return the divisions that the named user can administer from the list of all the delegates in the current heirarchy.
`static String[]`	`getDivisionsAsAdministrator(WTContainerRef aContainer, WTUser aUser)` This method will return the divisions that the named user can administer from the list of all the delegates in the current heirarchy.
`static String[]`	`getDivisionsAsAdministrator(WTUser user)` This method will return the divisions that the named user can administer from the list of all the delegates in the current heirarchy.
`static Long`	`getTimeOutInterval()`
`static void`	`setTimeOutInterval(Long time)`
`static String`	`transformContext(String context)` Performs transformations on context Transforms WTPreferences.USER_CONTEXT to WTPreferences.USER_CONTEXT + identity Supported API: false

Methods inherited from class java.lang.Object

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

Field Detail

cvDelegateHeirarchy

private static List cvDelegateHeirarchy

List of all DelegateStructures for initialized delegates

cvDelegates

private static Hashtable cvDelegates

The hashtable of all Delegates

cvDelegateList

private static String cvDelegateList

The most recently obtained heirarchy list from delegates.properties

cvLastUpdate

private static long cvLastUpdate

Get the last update of the delegate orders

TIME_OUT

private static long TIME_OUT

Timeout for properties refresh

cacheSize

private static int cacheSize

VERBOSE

private static boolean VERBOSE

DEF_CONTAINER_DEL

private static final String DEF_CONTAINER_DEL

Default container delegate class.

See Also:: Constant Field Values

cache

private static Cache cache

Constructor Detail