com.plumtree.portaluiinfrastructure.application.varpacks
Class PTDocTypesVarPack

java.lang.Object
  com.plumtree.uiinfrastructure.web.BaseVarPack
      com.plumtree.portaluiinfrastructure.application.varpacks.PTDocTypesVarPack

All Implemented Interfaces:

IVarPack

public class PTDocTypesVarPack
extends BaseVarPack

This VarPack contains the localized names for all the document types.

Author:

Jose Quezada

Field Summary

static java.lang.String

VARPACK_ID The string ID of this variable package.

Constructor Summary

PTDocTypesVarPack()
Constructor for PTDocTypesVarPack.

Method Summary

protected void	ExpireContent() You cannot expire the settings content.
java.lang.String	GetLocalizedName(java.lang.String _UUID, java.lang.String _langCode) Helper method that retrieves the localized name for the given UUID.
protected java.lang.Object	GetValue(java.lang.String _strUUID) this will return an XPHashtable mapping of UUIDs & doc type localized names for the locale code passed in.
java.lang.String	GetVarPackID() Get the id of this var pack instance.
IXPEnumerator	GetVarPackKeys() This method will return an enumeration of the UUIDs of doc types in this varpack.
protected void	Load() This method loads the doc types uuid & localized names into memory.
protected void	Reload() This method reloads the doc types uuid & localized names .

Methods inherited from class com.plumtree.uiinfrastructure.web.BaseVarPack

CanReloadVarPackFromUI, ExpireVarPackContent, GetConfigPath, GetExpireTimeout, GetLastAccessedTimeStamp, GetReloadInterval, GetVarPackValue, IsLoaded, LoadVarPack, ReloadVarPack, SetExpireTimeout, SetReloadInterval

Methods inherited from class java.lang.Object

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

Field Detail

VARPACK_ID

public static final java.lang.String VARPACK_ID

The string ID of this variable package.

See Also:

Constant Field Values

Constructor Detail

PTDocTypesVarPack

public PTDocTypesVarPack()

Constructor for PTDocTypesVarPack.

Parameters:

_strConfigFilePath - The path to the folder in which SearchLocales.xml resides.

Method Detail

GetVarPackID

public java.lang.String GetVarPackID()

Description copied from class: BaseVarPack

Get the id of this var pack instance. Note: VarPackManager only has 1 key per var pack. This should be unquie per class instance.

Specified by:

GetVarPackID in interface IVarPack

Specified by:

GetVarPackID in class BaseVarPack

Returns:

A unique key to store the var pack in the varpackmanager.

See Also:

IVarPack.GetVarPackID()

GetVarPackKeys

public IXPEnumerator GetVarPackKeys()

This method will return an enumeration of the UUIDs of doc types in this varpack.

Specified by:

GetVarPackKeys in interface IVarPack

Specified by:

GetVarPackKeys in class BaseVarPack

Returns:

IXPEnumerator of keys in the var pack.

See Also:

IVarPack.GetVarPackKeys()

ExpireContent

protected void ExpireContent()

You cannot expire the settings content. You can only reload it. This method does nothing.

Specified by:

ExpireContent in class BaseVarPack

See Also:

com.plumtree.xpsupport.web.BaseVarPack#ExpireContent()

GetValue

protected java.lang.Object GetValue(java.lang.String _strUUID)

this will return an XPHashtable mapping of UUIDs & doc type localized names for the locale code passed in. It is best to use the helper methods to get UUID to Name mappings.

Specified by:

GetValue in class BaseVarPack

Parameters:

_strUUID - The key for the lookup

Returns:

the value from the lookup (null if not found)

See Also:

com.plumtree.xpsupport.web.BaseVarPack#GetValue(String)

GetLocalizedName

public java.lang.String GetLocalizedName(java.lang.String _UUID,
                                         java.lang.String _langCode)

Helper method that retrieves the localized name for the given UUID.

Parameters:

_UUID -

_langCode -

Returns:

localized name if available, else, the 'en' lang name.

Load

protected void Load()

This method loads the doc types uuid & localized names into memory.

Specified by:

Load in class BaseVarPack

See Also:

com.plumtree.xpsupport.web.BaseVarPack#Load()

Reload

protected void Reload()

This method reloads the doc types uuid & localized names . It delegates to Load().

Specified by:

Reload in class BaseVarPack

See Also:

com.plumtree.xpsupport.web.BaseVarPack#Reload()