com.plumtree.portaluiinfrastructure.application.varpacks
Class PTDirPrefsVarPack

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

All Implemented Interfaces:

IVarPack

public class PTDirPrefsVarPack
extends BaseVarPack

This VarPack contains the localized names for all the installed locales.

Author:

Stephen Chang

Field Summary

static java.lang.String

VARPACK_ID The string ID of this variable package.

Constructor Summary

PTDirPrefsVarPack()
Constructor for PTDirPrefsVarPack.

Method Summary

protected void	CreateKeysArrayList()
protected void	ExpireContent() You cannot expire the settings content.
int	GetBrowseBy()
int	GetDefaultDocType()
java.lang.String	GetDocDescriptionType()
java.lang.String	GetFolderDescriptionType()
int	GetNumDocsPerPage()
int	GetNumFolderColumns()
int	GetNumSubSubFolders()
XPArrayList	GetPropColumns()
int	GetRelatedResourcesPlacement()
protected java.lang.Object	GetValue(java.lang.String strServerConfigID) Get a value from the Var pack.
java.lang.String	GetVarPackID() Get the id of this var pack instance.
IXPEnumerator	GetVarPackKeys() This method will return an enumeration of the top level nodes in the XML tree that is SearchLocales.xml.
protected void	Load() This method loads the DirPrefs settings from the PTServerConfig table into memory.
protected void	Reload() This method reloads the DirPrefs settings.

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

PTDirPrefsVarPack

public PTDirPrefsVarPack()

Constructor for PTDirPrefsVarPack.

Method Detail

CreateKeysArrayList

protected void CreateKeysArrayList()

GetBrowseBy

public int GetBrowseBy()

Returns:

GetDefaultDocType

public int GetDefaultDocType()

Returns:

GetDocDescriptionType

public java.lang.String GetDocDescriptionType()

Returns:

GetFolderDescriptionType

public java.lang.String GetFolderDescriptionType()

Returns:

GetNumDocsPerPage

public int GetNumDocsPerPage()

Returns:

GetNumFolderColumns

public int GetNumFolderColumns()

Returns:

GetNumSubSubFolders

public int GetNumSubSubFolders()

Returns:

GetPropColumns

public XPArrayList GetPropColumns()

Returns:

GetRelatedResourcesPlacement

public int GetRelatedResourcesPlacement()

Returns:

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 top level nodes in the XML tree that is SearchLocales.xml.

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 strServerConfigID)

Description copied from class: BaseVarPack

Get a value from the Var pack.

Specified by:

GetValue in class BaseVarPack

Parameters:

strServerConfigID - The key for the lookup

Returns:

the value from the lookup (null if not found)

See Also:

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

Load

protected void Load()

This method loads the DirPrefs settings from the PTServerConfig table into memory.

Specified by:

Load in class BaseVarPack

See Also:

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

Reload

protected void Reload()

This method reloads the DirPrefs settings. It delegates to Load().

Specified by:

Reload in class BaseVarPack

See Also:

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