com.sap.tc.webdynpro.progmodel.api
Interface IWDValidationCheck

public interface IWDValidationCheck

IWDValidationCheck offers access to the Web Dynpro validation managemnt service. The main purpose of this interface is:

Read validation information for context attributes

Set validation information for context attributes

Access external string representation of a context attribute

Method Summary

java.lang.String	getExternalValue(IWDNodeElement nodeElement, IWDAttributeInfo attrInfo) Get access to the external string representation of an context attribute.
boolean	isValidAttribute(IWDNodeElement elem, IWDAttributeInfo attr) Check if a context attribute is valid.
boolean	isValidNode(IWDNode node) Check if all context attributes are valid which are descendants relative to node.
boolean	isValidNodeElement(IWDNodeElement elem) Check if all context attributes are valid which are descendants relative to elem.
void	setAttributeValid(IWDNodeElement elem, IWDAttributeInfo attr) Set an attribute to valid.

Method Detail

isValidAttribute

public boolean isValidAttribute(IWDNodeElement elem,
                                IWDAttributeInfo attr)

Check if a context attribute is valid.

Returns:

true, when the given context is valid.

isValidNodeElement

public boolean isValidNodeElement(IWDNodeElement elem)

Check if all context attributes are valid which are descendants relative to elem.

Returns:

true, if all dependant attributes are valid.

isValidNode

public boolean isValidNode(IWDNode node)

Check if all context attributes are valid which are descendants relative to node.

Returns:

true, if all dependant attributes are valid.

setAttributeValid

public void setAttributeValid(IWDNodeElement elem,
                              IWDAttributeInfo attr)

Set an attribute to valid. Later checks for non validating action event handlers can execute if the event handler is dependent on this attribute.

NOTE: This method only sets the validation state of the attribute. It neither runs any validation routine nor is any further framework funtionality involved. It is up to the usage of this API to guarantee that validating an attribute is done in a reasonable manner.

getExternalValue

public java.lang.String getExternalValue(IWDNodeElement nodeElement,
                                         IWDAttributeInfo attrInfo)

Get access to the external string representation of an context attribute. This method returns either the string representation according to the data types format method or the string entered by the user in case the input can not be converted to the proper typed java representation. In any case this method returns the string as it will be displayed in the UI with the next repsonse send to the client.

Returns:

external string representation of the attribute.