com.sybase.uep.bobclient.actions
Class SubmitElement

java.lang.Object
  extended by com.sybase.uep.bobclient.actions.SubmitElement

public class SubmitElement
extends java.lang.Object

This is the submit element class

This class will contain information about the variable and inputs on the screen to save for operation submission

Author:
tdang

Constructor Summary
SubmitElement(java.lang.String displayName, java.lang.Object value, java.lang.String type, ControlVariable variable, boolean required, java.lang.String structureParamKey, int maxLength, java.lang.String fromAttribute, java.lang.String schemaType, boolean isList, SubValueDescriptorChain chain, boolean isValidateOnly)
          Constructor to create a submit element object
SubmitElement(java.lang.String displayName, java.lang.Object value, java.lang.String type, ControlVariable variable, boolean required, java.lang.String structureParamKey, java.lang.String fromAttribute, java.lang.String schemaType, boolean isList, SubValueDescriptorChain chain, boolean isValidateOnly)
          Constructor to create a submit element object
 
Method Summary
 java.lang.String getDisplayName()
          Return the display name for this input field
 java.lang.String getFromAttribute()
          Retrieve from attribute name
 int getMaxLength()
          Retrieve the maximum length
 java.lang.String getSchemaType()
          Retrieve schema type
 java.lang.String getStructureParamKey()
          Retrieve the structure parameter key value
 java.lang.String getType()
          Retrieve the type for this submit element
 java.lang.Object getValue()
          Retrieve the value for this submit element
 java.lang.Object getValueForSubmit()
          Retrieve the value that will be assign to the object api.
 ControlVariable getVariable()
          Retrieve the control variable object
 boolean isList()
          Return _isList
 boolean isRequired()
          Check to see if this submit element is required or not
 boolean isValidateOnly()
          Gets the _isValidateOnly
 void setValue(java.lang.Object value)
          Set the value for this submit element
 java.lang.String toString()
          Print out the submit element values
 Diagnostic validate(java.lang.String mboId)
          Checks if the submit value is valid
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SubmitElement

public SubmitElement(java.lang.String displayName,
                     java.lang.Object value,
                     java.lang.String type,
                     ControlVariable variable,
                     boolean required,
                     java.lang.String structureParamKey,
                     java.lang.String fromAttribute,
                     java.lang.String schemaType,
                     boolean isList,
                     SubValueDescriptorChain chain,
                     boolean isValidateOnly)
Constructor to create a submit element object

Parameters:
displayName - String value for the display name
value - Object value for the submit element
type - String value for the type of persist element, Can be the following VariableProperties.SUBMIT_USER_TYPE, VariableProperties.SUBMIT_CONTROL_TYPE, VariableProperties.SUBMIT_VARIABLE_TYPE, or VariableProperties.SUBMIT_NULL_TYPE,
variable - ControlVariable value for the control variable object. This is only use when the type is of VariableProperties.SUBMIT_VARIABLE_TYPE
required - true if this parameter is required, if so we need to validate, otherwise false
structureParamKey - String value for the structure parameter key
fromAttribute - String value for the from attribute name
schemaType - String value for the schema type
See Also:
VariableProperties, ControlVariable

SubmitElement

public SubmitElement(java.lang.String displayName,
                     java.lang.Object value,
                     java.lang.String type,
                     ControlVariable variable,
                     boolean required,
                     java.lang.String structureParamKey,
                     int maxLength,
                     java.lang.String fromAttribute,
                     java.lang.String schemaType,
                     boolean isList,
                     SubValueDescriptorChain chain,
                     boolean isValidateOnly)
Constructor to create a submit element object

Parameters:
displayName - String value for the display name
value - Object value for the submit element
type - String value for the type of persist element, Can be the following VariableProperties.SUBMIT_USER_TYPE, VariableProperties.SUBMIT_CONTROL_TYPE, VariableProperties.SUBMIT_VARIABLE_TYPE, or VariableProperties.SUBMIT_NULL_TYPE,
variable - ControlVariable value for the control variable object. This is only use when the type is of VariableProperties.SUBMIT_VARIABLE_TYPE
required - true if this parameter is required, if so we need to validate, otherwise false
structureParamKey - String value for the structure parameter key
maxLength - int value for the maximum length of the input field, -1 for undefined
fromAttribute - String value for the from attribute name
schemaType - String value for the schema type
Method Detail

getDisplayName

public java.lang.String getDisplayName()
Return the display name for this input field

Returns:
String value for the display name

getSchemaType

public java.lang.String getSchemaType()
Retrieve schema type

Returns:
String value of the schema type

getFromAttribute

public java.lang.String getFromAttribute()
Retrieve from attribute name

Returns:
String value of the from attribute name

getType

public java.lang.String getType()
Retrieve the type for this submit element

Returns:
String value of the submit element type

getVariable

public ControlVariable getVariable()
Retrieve the control variable object

This is only used if the type is of VariableProperties.SUBMIT_VARIABLE_TYPE

Returns:
ControlVariable value for the variable

getValue

public java.lang.Object getValue()
Retrieve the value for this submit element

Returns:
String value

setValue

public void setValue(java.lang.Object value)
Set the value for this submit element

Parameters:
value - Object value

isRequired

public boolean isRequired()
Check to see if this submit element is required or not

Returns:
true if control is required, otherwise false

getStructureParamKey

public java.lang.String getStructureParamKey()
Retrieve the structure parameter key value

Returns:
String value for the structure parameter key

getMaxLength

public int getMaxLength()
Retrieve the maximum length

Returns:
int value for the maximum length

isList

public boolean isList()
Return _isList

Returns:

getValueForSubmit

public java.lang.Object getValueForSubmit()
Retrieve the value that will be assign to the object api.

Returns:

validate

public Diagnostic validate(java.lang.String mboId)
Checks if the submit value is valid

Parameters:
mboId - id of the MBO which will be validated against
Returns:

toString

public java.lang.String toString()
Print out the submit element values

Overrides:
toString in class java.lang.Object
Returns:
String value of all the attributes

isValidateOnly

public boolean isValidateOnly()
Gets the _isValidateOnly

Returns: