psdi.webclient.system.session

Class ConditionalUIHelper

java.lang.Object

psdi.webclient.system.session.ConditionalUIHelper

public class ConditionalUIHelper
extends java.lang.Object

This is a conditional UI helper class. There should be only one instance of this class per WebClientSession and that instance should be obtained via the WebClientSession getConditionalUIHelper method.

Method Summary

Modifier and Type	Method and Description
boolean	evaluateCondRequired(UIERMEntity entity, MboSetRemote mboSetRemote) Starting with the passed in MboSetRemote this method traverses the MboSet tree and tries to evaluate all inputmode related conditional ui conditions on all the Mbo's using the passed in UIERMEntity as a means of determining whether the MboSet or child mboset has conditional ui.
java.util.Map	getConditionalProperties(java.lang.String sigOption, MboRemote mbo) For the given sigoption and mbo, this method will return a map of properties and their values as a result of evaluating conditional ui associated with the sigoption.
java.util.HashMap	getPropsFromPropertyCache(java.lang.String sigOption, java.util.TreeMap condResults) This method will return a Map of properties and their new values based on the conditional UI condition evaluation TreeMap passed in.

Methods inherited from class java.lang.Object

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

Method Detail

getPropsFromPropertyCache

public java.util.HashMap getPropsFromPropertyCache(java.lang.String sigOption,
                                                   java.util.TreeMap condResults)
                                            throws java.rmi.RemoteException,
                                                   MXException

This method will return a Map of properties and their new values based on the conditional UI condition evaluation TreeMap passed in. The TreeMap passed in should have the structure of integer as the key, which is the order in which the conditions were evaluated and the value will be an String array with a length of 2. Index 1 of the array will be the conditionnum of the condition that was evaluated and index 2 of the array will result of the evaluation either true or false.

Parameters:

sigOption - The sigoption the conditional ui

condResults - A tree map containing the results of the conditional ui conditions associated with the sigoption

Returns:

A Map of properties and their new values as a result of the condition results passed to be used by any control with that sigoption.

Throws:

java.rmi.RemoteException

MXException

evaluateCondRequired

public boolean evaluateCondRequired(UIERMEntity entity,
                                    MboSetRemote mboSetRemote)
                             throws java.rmi.RemoteException,
                                    MXException

Starting with the passed in MboSetRemote this method traverses the MboSet tree and tries to evaluate all inputmode related conditional ui conditions on all the Mbo's using the passed in UIERMEntity as a means of determining whether the MboSet or child mboset has conditional ui. Conditional ui will only be evaluated on MboSets and mbos read into memory and only on Mbos that that have been modified or new.

Parameters:

entity - The UIERMEntity to start the process of finding the conditionally required fields

mboSetRemote - The MboSet of the data source represented by the entity parameter

Throws:

java.rmi.RemoteException

MXException

getConditionalProperties

public java.util.Map getConditionalProperties(java.lang.String sigOption,
                                              MboRemote mbo)
                                       throws java.rmi.RemoteException,
                                              MXException

For the given sigoption and mbo, this method will return a map of properties and their values as a result of evaluating conditional ui associated with the sigoption.

Parameters:

sigOption - the sigoption to check conditional ui

mbo - the mbo to evaluate the conditional ui conditional against

Returns:

map of conditional properties and their values

Throws:

java.rmi.RemoteException

MXException