Class ParamExpressionObject

java.lang.Object

org.bgerp.dao.expression.ParamExpressionObject

All Implemented Interfaces:

ExpressionObject

Direct Known Subclasses:

ProcessParamExpressionObject, UserParamExpressionObject

public class ParamExpressionObject
extends Object
implements ExpressionObject

Expression object for accessing object parameter values

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	context	for generated events

Constructor Summary

Constructors

Constructor	Description
ParamExpressionObject(Connection con, int objectId)

Method Summary

Modifier and Type	Method	Description
Set<Integer>	addressAreaIds(int paramId)	Selects set with area IDs of parameter with type address
Set<Integer>	addressCityIds(int paramId)	Selects set with city IDs of parameter with type address
Set<Integer>	addressQuarterIds(int paramId)	Selects set with quarter IDs of parameter with type address
Set<Integer>	addressStreetIds(int paramId)	Selects set with street IDs of parameter with type address
List<String>	addressValues(int paramId)	Deprecated.
List<String>	addressValues(int paramId, String formatName)	Selects address parameter values strings
Date	dateValue(int paramId)	Selects value of date and datetime parameter types
ParamExpressionObject	e()	Sets param change events generation when using sval(int, String)
protected Collection<ParameterAddressValue>	getParamAddressValues(int paramId, String formatName)
Date	getParamDate(int paramId)	Deprecated.
Date	getParamDateTime(int paramId)	Deprecated.
String	getParamPhoneNoFormat(int paramId)	Deprecated.
String	getParamText(int paramId)	Deprecated.
String	getValue(int paramId)	Selects parameter values for the current object
Set<Integer>	listValueIds(int paramId)	Selects value IDs of list and listcount parameter types
Set<String>	listValueTitles(int paramId)	Deprecated.
void	sval(int paramId, String value)	Set parameter value(s) out of a string representation, the following parameter types are not supported: Parameter.Type.ADDRESS, Parameter.Type.FILE, Parameter.Type.LISTCOUNT, Parameter.Type.TREE, Parameter.Type.TREECOUNT The value treated as: - Parameter.Type.BLOB - string value - Parameter.Type.DATE - formatted date string - Parameter.Type.DATETIME - formatted datetime string - Parameter.Type.EMAIL - comma-separated email addresses with possible display names - Parameter.Type.LIST - comma-separated list value IDs - Parameter.Type.MONEY - dot-separated decimal number - Parameter.Type.PHONE - phone-separated phone numbers without format, only E164 digits - Parameter.Type.TEXT - string value
void	toContext(Map<String,Object> context)
String	val(int paramId)	Selects parameter values for the current object
Object	val(int paramId, String format)	Selects parameter values for the current object

Methods inherited from class Object

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

Field Details

context

protected Map<String,Object> context

for generated events

Constructor Details

ParamExpressionObject

public ParamExpressionObject(Connection con,
 int objectId)

Method Details

toContext

public void toContext(Map<String,Object> context)

Specified by:

toContext in interface ExpressionObject

e

public ParamExpressionObject e()

Sets param change events generation when using sval(int, String)

Returns:

this

addressValues

public List<String> addressValues(int paramId,
 String formatName)

Selects address parameter values strings

Parameters:

paramId - the parameter ID

formatName - optional address format, null for using the default one

Returns:

list of address strings

addressCityIds

public Set<Integer> addressCityIds(int paramId)

Selects set with city IDs of parameter with type address

Parameters:

paramId - the parameter ID

Returns:

not null set of values

addressStreetIds

public Set<Integer> addressStreetIds(int paramId)

Selects set with street IDs of parameter with type address

Parameters:

paramId - the parameter ID

Returns:

not null set of values

addressQuarterIds

public Set<Integer> addressQuarterIds(int paramId)

Selects set with quarter IDs of parameter with type address

Parameters:

paramId - the parameter ID

Returns:

not null set of values

addressAreaIds

public Set<Integer> addressAreaIds(int paramId)

Selects set with area IDs of parameter with type address

Parameters:

paramId - the parameter ID

Returns:

not null set of values

getParamAddressValues

protected Collection<ParameterAddressValue> getParamAddressValues(int paramId,
 String formatName)

dateValue

public Date dateValue(int paramId)

Selects value of date and datetime parameter types

Parameters:

paramId - the parameter ID

Returns:

the value or null

listValueIds

public Set<Integer> listValueIds(int paramId)

Selects value IDs of list and listcount parameter types

Parameters:

paramId - the parameter ID

Returns:

not null set of values

val

public Object val(int paramId,
 String format)

Selects parameter values for the current object

Parameters:

paramId - the parameter ID

format - optional format of the result:

nf for param type phone returns ParameterPhoneValue object

Returns:

parameter's value, string if no is defined

val

public String val(int paramId)

Selects parameter values for the current object

Parameters:

paramId - the parameter ID

Returns:

string representation of the parameter value

getValue

public String getValue(int paramId)

Selects parameter values for the current object

Parameters:

paramId - the parameter ID

Returns:

string representation of the parameter value

sval

public void sval(int paramId,
 String value)
          throws Exception

Set parameter value(s) out of a string representation, the following parameter types are not supported: Parameter.Type.ADDRESS, Parameter.Type.FILE, Parameter.Type.LISTCOUNT, Parameter.Type.TREE, Parameter.Type.TREECOUNT
The value treated as:
- Parameter.Type.BLOB - string value
- Parameter.Type.DATE - formatted date string
- Parameter.Type.DATETIME - formatted datetime string
- Parameter.Type.EMAIL - comma-separated email addresses with possible display names
- Parameter.Type.LIST - comma-separated list value IDs
- Parameter.Type.MONEY - dot-separated decimal number
- Parameter.Type.PHONE - phone-separated phone numbers without format, only E164 digits
- Parameter.Type.TEXT - string value

Parameters:

paramId - the parameter ID

value - the string representation

Throws:

Exception

addressValues

@Deprecated
public List<String> addressValues(int paramId)

Deprecated.

Use ParamValueDAO.getParamAddress(int, int)

listValueTitles

@Deprecated
public Set<String> listValueTitles(int paramId)

Deprecated.

Use getValue(int)

getParamText

@Deprecated
public String getParamText(int paramId)
                    throws SQLException

Deprecated.

Use ParamValueDAO.getParamText(int, int)

Throws:

SQLException

getParamDate

@Deprecated
public Date getParamDate(int paramId)
                  throws SQLException

Deprecated.

Use ParamValueDAO.getParamDate(int, int)

Throws:

SQLException

getParamDateTime

@Deprecated
public Date getParamDateTime(int paramId)
                      throws SQLException

Deprecated.

Use ParamValueDAO.getParamDateTime(int, int)

Throws:

SQLException

getParamPhoneNoFormat

@Deprecated
public String getParamPhoneNoFormat(int paramId)
                             throws SQLException

Deprecated.

Use ParamValueDAO.getParamPhone(int, int)

Throws:

SQLException