psdi.webclient.system.erm

Class UIERMAttribute

java.lang.Object

psdi.common.erm.ERMAttribute

psdi.webclient.system.erm.UIERMAttribute

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class UIERMAttribute
extends ERMAttribute
implements java.io.Serializable, java.lang.Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UIERMAttribute(java.lang.String dataAttr) Constructor Takes the name of the attribute

Method Summary

Modifier and Type	Method and Description
void	addControl(UIERMBoundControl control) Adds a control and it's BindingDefinition to the list of controls bound to the attribute.
void	cleanup()
UIERMAttribute	clone()
com.ibm.json.java.JSONArray	createTakesValueList(PageInstance page) Returns a JSONArray containing a the render id's of the takesvalue BoundComponentInstances that are bound to this attribute.
java.util.List<UIERMBoundControl>	getControls() Returns a Map contains the ids of the controls bound to this attribute and there BindingDefintions.
DataStoreInfo	getDataStoreInfo()
java.lang.String	getLabelForAttribute(WebClientSession wcs)
UIERMEntity	getSigOptEntity()
java.lang.String	getSigOption()
boolean	isCloned()
boolean	isPresentationRequired() Returns true if the presentation xml has marked the attribute as required.
boolean	isRequired() Returns true if the presentation xml has marked the attribute as required and if the attribute cannot be set conditionally required.
void	setDataStoreInfo(DataStoreInfo dataStoreInfo)
void	setIsCloned(boolean aBool)
void	setRequired(boolean required) Sets whether or not this attribute is required.
void	setSigOption(java.lang.String sigOption, UIERMEntity sigOptEntity)

Methods inherited from class psdi.common.erm.ERMAttribute

getEntity, getName, setEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

UIERMAttribute

public UIERMAttribute(java.lang.String dataAttr)

Constructor Takes the name of the attribute

Parameters:

dataAttr - The name of the attribute

Method Detail

addControl

public void addControl(UIERMBoundControl control)

Adds a control and it's BindingDefinition to the list of controls bound to the attribute.

Parameters:

controlId - The id of the control to add to the list of controls bound to this attribute

bindingDef - The BindingDefinition of the control

getControls

public java.util.List<UIERMBoundControl> getControls()

Returns a Map contains the ids of the controls bound to this attribute and there BindingDefintions. Will return null if no control are bound to this attribute, but that should never be the case.

Returns:

A map of the controls bound to this attribute

getLabelForAttribute

public java.lang.String getLabelForAttribute(WebClientSession wcs)

setSigOption

public void setSigOption(java.lang.String sigOption,
                         UIERMEntity sigOptEntity)

isRequired

public boolean isRequired()

Returns true if the presentation xml has marked the attribute as required and if the attribute cannot be set conditionally required. So if conditional UI can change requiredness then this will return false. If you want to know if it's required on the presentatrion call isPresentationRequired

Overrides:

isRequired in class ERMAttribute

Returns:

true the attribute is required, false it is not required by the presentation.

isPresentationRequired

public boolean isPresentationRequired()

Returns true if the presentation xml has marked the attribute as required. This is different than the call to isRequired which will return false if the attribute can be set conditionally required.

See Also:

ERMAttribute.isRequired()

getSigOption

public java.lang.String getSigOption()

Returns:

the sigOption

getSigOptEntity

public UIERMEntity getSigOptEntity()

Returns:

the sigOptEntity

setRequired

public void setRequired(boolean required)

Description copied from class: ERMAttribute

Sets whether or not this attribute is required.

Overrides:

setRequired in class ERMAttribute

Parameters:

required - true if required, false if not

getDataStoreInfo

public DataStoreInfo getDataStoreInfo()

setDataStoreInfo

public void setDataStoreInfo(DataStoreInfo dataStoreInfo)

createTakesValueList

public com.ibm.json.java.JSONArray createTakesValueList(PageInstance page)

Returns a JSONArray containing a the render id's of the takesvalue BoundComponentInstances that are bound to this attribute. The list will only contained BoundComponents that have been instantiated and on the passed in Page.

isCloned

public boolean isCloned()

setIsCloned

public void setIsCloned(boolean aBool)

clone

public UIERMAttribute clone()
                     throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

cleanup

public void cleanup()

Overrides:

cleanup in class ERMAttribute