|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.web.BaseVarPack
public abstract class BaseVarPack
Base class for var packs to extend. BaseVarPack adds common features.
Constructor Summary | |
---|---|
BaseVarPack()
An abstract Var pack to extend off of. |
Method Summary | |
---|---|
boolean |
CanReloadVarPackFromUI()
By default VarPacks cannot be reloaded from the UI. |
protected abstract void |
ExpireContent()
Expire content in this var pack. |
void |
ExpireVarPackContent()
Expire content in this var pack. |
java.lang.String |
GetConfigPath()
Gets the path to the configuration directory, if there is any. |
int |
GetExpireTimeout()
Get how many seconds of innactivity until this var pack unloads |
XPDateTime |
GetLastAccessedTimeStamp()
Get the last accessed time stamp. |
int |
GetReloadInterval()
Get number of seconds before the var pack should be reloaded. |
protected abstract java.lang.Object |
GetValue(java.lang.String key)
Get a value from the Var pack. |
abstract java.lang.String |
GetVarPackID()
Get the id of this var pack instance. |
abstract IXPEnumerator |
GetVarPackKeys()
Get an enumeration of keys in the var pack. |
java.lang.Object |
GetVarPackValue(java.lang.String key)
Get a value from the Var pack. |
boolean |
IsLoaded()
Check to see if the var pack currently is loaded |
protected abstract void |
Load()
Load the var pack. |
void |
LoadVarPack(java.lang.String strConfigPath)
Load this var pack. |
protected abstract void |
Reload()
Reload the var pack. |
void |
ReloadVarPack()
Reload this var pack. |
void |
SetExpireTimeout(int time)
Get how many seconds of innactivity until this var pack unloads |
void |
SetReloadInterval(int numberOfSeconds)
Set the number of seconds before the var pack should be reloaded. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BaseVarPack()
Method Detail |
---|
public java.lang.String GetConfigPath()
public XPDateTime GetLastAccessedTimeStamp()
public int GetExpireTimeout()
public int GetReloadInterval()
public abstract java.lang.String GetVarPackID()
GetVarPackID
in interface IVarPack
public abstract IXPEnumerator GetVarPackKeys()
GetVarPackKeys
in interface IVarPack
public final void ExpireVarPackContent()
ExpireVarPackContent
in interface IVarPack
public final java.lang.Object GetVarPackValue(java.lang.String key)
GetVarPackValue
in interface IVarPack
key
- The key for the lookup
XPException
- if VarPack has not been loaded.GetValue(String)
public boolean IsLoaded()
public final void LoadVarPack(java.lang.String strConfigPath)
LoadVarPack
in interface IVarPack
strConfigPath
- the path to the configuration folder.
This may be null or the empty string if there is no configuration
folder set up (for instance, when loading VarPacks from the VarPack
XML file specified in the web.config or web.xml files)Load()
public final void ReloadVarPack()
ReloadVarPack
in interface IVarPack
Reload()
public boolean CanReloadVarPackFromUI()
CanReloadVarPackFromUI
in interface IVarPack
public void SetExpireTimeout(int time)
time
- number of secondspublic void SetReloadInterval(int numberOfSeconds)
numberOfSeconds
- Number of seconds.protected abstract void ExpireContent()
protected abstract java.lang.Object GetValue(java.lang.String key)
key
- The key for the lookup
protected abstract void Load()
protected abstract void Reload()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |