psdi.app.appsetup

Class CtrlCondPropCache

java.lang.Object

psdi.app.appsetup.CtrlCondPropCache

All Implemented Interfaces:

MaximoCache, FixedLoggerNames, FixedLoggers

public class CtrlCondPropCache
extends java.lang.Object
implements MaximoCache, FixedLoggers

Maximo cache of all the control condition properties stored in the control condition properties table.

Field Summary

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
CtrlCondPropCache()

Method Summary

Modifier and Type	Method and Description
java.util.TreeMap<java.lang.Integer,java.lang.String[]>	getCtrlConditions(java.lang.String app, java.lang.String optionname, java.util.HashSet groupNames) Read CtrlGroup and CtrlCondition for the given app and optionname.
java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Object>>	getCtrlGroups(java.lang.String app, java.lang.String optionname) Get the entry in ctrlGroups for the given app and optionname.
java.util.HashMap<java.lang.String,java.lang.String>	getLoadedProperties(java.lang.String langCode, java.lang.String ctrlConditionID, java.lang.String result) Retrieve the properties Hash from the data structure.
java.lang.String	getName() Returns "CTRLCONDPROP" - the name of the cache object.
java.util.HashMap<java.lang.String,java.lang.String>	getPropertyCache(UserInfo ui, java.lang.String ctrlConditionID, java.lang.String result) Get the HashMap of properties by language code(using UserInfo), condition identifier, and condition result.
java.util.TreeSet<java.lang.String>	getPropertyList() Returns a list (TreeMap) of all possible properties that can be conditional changed.
void	init() Initialize the cache object.
void	init(MXServer mxs) Does same as init();
void	reload() Reloads the cache object.
void	reload(java.lang.String key) Not used.
void	setPropertyList(java.util.TreeSet<java.lang.String> propertyList) Caches a list (TreeSet) of all possible properties that can be conditional changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

CtrlCondPropCache

public CtrlCondPropCache()

Method Detail

getName

public java.lang.String getName()

Returns "CTRLCONDPROP" - the name of the cache object. This is unique within the app server. This name is used to uniquely identify the cache object among all cached object for both accessing the cache object as well as refreshing the cache object.

Specified by:

getName in interface MaximoCache

Returns:

init

public void init()
          throws MXException

Initialize the cache object. This will be called by the app server on startup.

Specified by:

init in interface MaximoCache

Throws:

MXException

reload

public void reload()
            throws MXException

Reloads the cache object. It simply clears everything in the cache. Values are then reloaded on demand. This will be called by the app server whenever the cache needs to be refreshed. Called whenever CtrlCondPropSet saves a modified set.

Specified by:

reload in interface MaximoCache

Throws:

MXException

See Also:

MaximoCache.reload(), #reloadCache

reload

public void reload(java.lang.String key)
            throws MXException

Not used.

Specified by:

reload in interface MaximoCache

Parameters:

key -

Throws:

MXException

init

public void init(MXServer mxs)
          throws MXException

Does same as init();

Throws:

MXException

getPropertyCache

public java.util.HashMap<java.lang.String,java.lang.String> getPropertyCache(UserInfo ui,
                                                                             java.lang.String ctrlConditionID,
                                                                             java.lang.String result)
                                                                      throws MXException,
                                                                             java.rmi.RemoteException

Get the HashMap of properties by language code(using UserInfo), condition identifier, and condition result.

Parameters:

UserInfo - ui

String - ctrlConditionID

String - result

Returns:

HashMap

Throws:

MXException

java.rmi.RemoteException

getLoadedProperties

public java.util.HashMap<java.lang.String,java.lang.String> getLoadedProperties(java.lang.String langCode,
                                                                                java.lang.String ctrlConditionID,
                                                                                java.lang.String result)

Retrieve the properties Hash from the data structure. It is assumed that all required tests/attempts to load the data were already performed.

Parameters:

String - langCode

String - ctrlConditionID

langCode -

getCtrlGroups

public java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Object>> getCtrlGroups(java.lang.String app,
                                                                                                               java.lang.String optionname)
                                                                                                        throws MXException,
                                                                                                               java.rmi.RemoteException

Get the entry in ctrlGroups for the given app and optionname. If the app is not already in ctrlGroups, it will be loaded.

Parameters:

app - Application name

optionname - Sigoption optionname

Returns:

TreeMap entry from ctrlGroups. If app or optionname not found, this will be empty.

Throws:

MXException

java.rmi.RemoteException

getCtrlConditions

public java.util.TreeMap<java.lang.Integer,java.lang.String[]> getCtrlConditions(java.lang.String app,
                                                                                 java.lang.String optionname,
                                                                                 java.util.HashSet groupNames)
                                                                          throws MXException,
                                                                                 java.rmi.RemoteException

Read CtrlGroup and CtrlCondition for the given app and optionname. Load the ConditionIDs and ConditionNums into a TreeMap where key is Integer. The returned TreeMap will iterate in the proper sequence, based on groupseq and conditionseq.

Parameters:

app - Application name

optionname - Option name

groupNames - The security groups to which the relevant user belongs. The condition will be returned only if it is related to one of the user's security groups.

Returns:

TreeMap where key is Integer and value is array of CtrlConditionID [0] and ConditionNum [1].

Throws:

MXException

java.rmi.RemoteException

See Also:

getCtrlGroups(java.lang.String, java.lang.String), loadCtrlConditions(java.lang.Long)

getPropertyList

public java.util.TreeSet<java.lang.String> getPropertyList()
                                                    throws MXException

Returns a list (TreeMap) of all possible properties that can be conditional changed.

Returns:

Throws:

MXException

setPropertyList

public void setPropertyList(java.util.TreeSet<java.lang.String> propertyList)
                     throws MXException

Caches a list (TreeSet) of all possible properties that can be conditional changed.

Throws:

MXException