Package org.apache.ofbiz.service
Class ModelParam
- java.lang.Object
-
- org.apache.ofbiz.service.ModelParam
-
- All Implemented Interfaces:
java.io.Serializable
public class ModelParam extends java.lang.Object implements java.io.Serializable
Generic Service Model Parameter- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description java.lang.String
allowHtml
Default valuejava.lang.String
description
The description of this parameterjava.lang.String
entityName
The entity namejava.lang.String
fieldName
The entity field nameboolean
formDisplay
Is this parameter to be displayed via the form tool?java.lang.String
formLabel
The form labelboolean
internal
Is this Parameter set internally?java.lang.String
mode
Parameter mode (IN/OUT/INOUT)static java.lang.String
module
java.lang.String
name
Parameter nameboolean
optional
Is this Parameter required or optional? Default to false, or requiredboolean
overrideFormDisplay
boolean
overrideOptional
java.lang.String
requestAttributeName
Request attribute to look for if not defined as a parameterjava.lang.String
sessionAttributeName
Session attribute to look for if not defined as a parameterjava.lang.String
stringListSuffix
Parameter suffix for creating an attribute Listjava.lang.String
stringMapPrefix
Parameter prefix for creating an attribute Mapjava.lang.String
type
Paramater typejava.util.List<org.apache.ofbiz.service.ModelParam.ModelParamValidator>
validators
Validation methods
-
Constructor Summary
Constructors Constructor Description ModelParam()
ModelParam(ModelParam param)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addValidator(java.lang.String className, java.lang.String methodName, java.lang.String failMessage)
void
addValidator(java.lang.String className, java.lang.String methodName, java.lang.String failResource, java.lang.String failProperty)
void
copyDefaultValue(ModelParam param)
boolean
equals(java.lang.Object obj)
boolean
equals(ModelParam model)
java.lang.Object
getDefaultValue()
java.lang.String
getEntityName()
java.lang.String
getFieldName()
java.lang.String
getFormLabel()
boolean
getInternal()
java.lang.String
getMode()
java.lang.String
getName()
java.lang.String
getPrimaryFailMessage(java.util.Locale locale)
java.lang.String
getShortDisplayDescription()
java.lang.String
getType()
javax.wsdl.Part
getWSDLPart(javax.wsdl.Definition def)
int
hashCode()
boolean
isIn()
boolean
isOptional()
boolean
isOut()
protected java.lang.String
java2wsdlType()
void
setDefaultValue(java.lang.String defaultValue)
java.lang.String
toString()
-
-
-
Field Detail
-
module
public static final java.lang.String module
-
name
public java.lang.String name
Parameter name
-
description
public java.lang.String description
The description of this parameter
-
type
public java.lang.String type
Paramater type
-
mode
public java.lang.String mode
Parameter mode (IN/OUT/INOUT)
-
formLabel
public java.lang.String formLabel
The form label
-
entityName
public java.lang.String entityName
The entity name
-
fieldName
public java.lang.String fieldName
The entity field name
-
requestAttributeName
public java.lang.String requestAttributeName
Request attribute to look for if not defined as a parameter
-
sessionAttributeName
public java.lang.String sessionAttributeName
Session attribute to look for if not defined as a parameter
-
stringMapPrefix
public java.lang.String stringMapPrefix
Parameter prefix for creating an attribute Map
-
stringListSuffix
public java.lang.String stringListSuffix
Parameter suffix for creating an attribute List
-
validators
public java.util.List<org.apache.ofbiz.service.ModelParam.ModelParamValidator> validators
Validation methods
-
optional
public boolean optional
Is this Parameter required or optional? Default to false, or required
-
overrideOptional
public boolean overrideOptional
-
formDisplay
public boolean formDisplay
Is this parameter to be displayed via the form tool?
-
overrideFormDisplay
public boolean overrideFormDisplay
-
allowHtml
public java.lang.String allowHtml
Default value
-
internal
public boolean internal
Is this Parameter set internally?
-
-
Constructor Detail
-
ModelParam
public ModelParam()
-
ModelParam
public ModelParam(ModelParam param)
-
-
Method Detail
-
addValidator
public void addValidator(java.lang.String className, java.lang.String methodName, java.lang.String failMessage)
-
addValidator
public void addValidator(java.lang.String className, java.lang.String methodName, java.lang.String failResource, java.lang.String failProperty)
-
getPrimaryFailMessage
public java.lang.String getPrimaryFailMessage(java.util.Locale locale)
-
getShortDisplayDescription
public java.lang.String getShortDisplayDescription()
-
getName
public java.lang.String getName()
-
getFormLabel
public java.lang.String getFormLabel()
-
getType
public java.lang.String getType()
-
getMode
public java.lang.String getMode()
-
getEntityName
public java.lang.String getEntityName()
-
getFieldName
public java.lang.String getFieldName()
-
getInternal
public boolean getInternal()
-
isIn
public boolean isIn()
-
isOut
public boolean isOut()
-
isOptional
public boolean isOptional()
-
getDefaultValue
public java.lang.Object getDefaultValue()
-
setDefaultValue
public void setDefaultValue(java.lang.String defaultValue)
-
copyDefaultValue
public void copyDefaultValue(ModelParam param)
-
equals
public boolean equals(ModelParam model)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getWSDLPart
public javax.wsdl.Part getWSDLPart(javax.wsdl.Definition def)
-
java2wsdlType
protected java.lang.String java2wsdlType()
-
-