com.viaoa.object

Class OACalcInfo

java.lang.Object

com.viaoa.object.OACalcInfo

All Implemented Interfaces:

Serializable

public class OACalcInfo
extends Object
implements Serializable

Used to define calculated properties for OAObject. A Calculated property is a read only property that depends on other properties for its value.
When a calclualted property is being used, a listener is set up that will listen for changes to any of the dependent properties.

Note: listeners for dependent properties are only created when there is a HubListener for the calculated property itself.

    Example:  
        Class Emp
            String firstName
            String lastName
            Dept dept;
            public String fullName() {
                return firstName + " " + lastName + " Dept " + dept.getName();   
            }
                
        OACalcInfo = new OACalcInfo("fullName",String { "firstName", "lastName", "dept.name" } );            
    

OACalcInfo is created and then stored within an OAObjectInfo object and is used by an OAObject. OAObject will automatically listen for property changes on any of the depended properties and will notify listeners whenever any change occurs that might affect the calculated property.

For more information about this package, see documentation.

Author:

Vince Via

See Also:

OAObjectInfo, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OACalcInfo(String name, String[] props) Create new Calculated Property.
OACalcInfo(String name, String[] props, boolean bIsForHub)

Method Summary

Modifier and Type	Method and Description
Class	getClassType()
String[]	getContextDependentProperties()
String	getContextEnabledProperty()
boolean	getContextEnabledValue()
String	getContextVisibleProperty()
boolean	getContextVisibleValue()
String[]	getDependentProperties() get property paths of all dependent properties
Method	getEditQueryMethod()
String	getEnabledProperty()
boolean	getEnabledValue()
boolean	getIsForHub()
String	getName() get Calculated Property name
OACalculatedProperty	getOACalculatedProperty()
String[]	getViewDependentProperties()
String	getVisibleProperty()
boolean	getVisibleValue()
boolean	isHtml()
void	setClassType(Class classType)
void	setContextDependentProperties(String[] ss)
void	setContextEnabledProperty(String s)
void	setContextEnabledValue(boolean b)
void	setContextVisibleProperty(String s)
void	setContextVisibleValue(boolean b)
void	setDependentProperties(String[] props)
void	setEditQueryMethod(Method m)
void	setEnabledProperty(String s)
void	setEnabledValue(boolean b)
void	setHtml(boolean b)
void	setOACalculatedProperty(OACalculatedProperty c)
void	setViewDependentProperties(String[] ss)
void	setVisibleProperty(String s)
void	setVisibleValue(boolean b)

Methods inherited from class java.lang.Object

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

Constructor Detail

OACalcInfo

public OACalcInfo(String name,
                  String[] props)

Create new Calculated Property.

 Example:  
   new CalcInfo("totalCostOfOrder",String { "orderItem.qty", "orderItem.product.cost", "customer.freight", "customer.state.taxRate" } );            
 

Parameters:

name - name of calculated property

props - array of depend property paths

OACalcInfo

public OACalcInfo(String name,
                  String[] props,
                  boolean bIsForHub)

Method Detail

getClassType

public Class getClassType()

setClassType

public void setClassType(Class classType)

getName

public String getName()

get Calculated Property name

isHtml

public boolean isHtml()

setHtml

public void setHtml(boolean b)

getDependentProperties

public String[] getDependentProperties()

get property paths of all dependent properties

setDependentProperties

public void setDependentProperties(String[] props)

getIsForHub

public boolean getIsForHub()

getOACalculatedProperty

public OACalculatedProperty getOACalculatedProperty()

setOACalculatedProperty

public void setOACalculatedProperty(OACalculatedProperty c)

setViewDependentProperties

public void setViewDependentProperties(String[] ss)

getViewDependentProperties

public String[] getViewDependentProperties()

setContextDependentProperties

public void setContextDependentProperties(String[] ss)

getContextDependentProperties

public String[] getContextDependentProperties()

getEnabledProperty

public String getEnabledProperty()

setEnabledProperty

public void setEnabledProperty(String s)

getEnabledValue

public boolean getEnabledValue()

setEnabledValue

public void setEnabledValue(boolean b)

getVisibleProperty

public String getVisibleProperty()

setVisibleProperty

public void setVisibleProperty(String s)

getVisibleValue

public boolean getVisibleValue()

setVisibleValue

public void setVisibleValue(boolean b)

getContextEnabledProperty

public String getContextEnabledProperty()

setContextEnabledProperty

public void setContextEnabledProperty(String s)

getContextEnabledValue

public boolean getContextEnabledValue()

setContextEnabledValue

public void setContextEnabledValue(boolean b)

getContextVisibleProperty

public String getContextVisibleProperty()

setContextVisibleProperty

public void setContextVisibleProperty(String s)

getContextVisibleValue

public boolean getContextVisibleValue()

setContextVisibleValue

public void setContextVisibleValue(boolean b)

setEditQueryMethod

public void setEditQueryMethod(Method m)

getEditQueryMethod

public Method getEditQueryMethod()