org.ofbiz.service
Class ModelParam

java.lang.Object
  org.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

java.lang.String	allowHtml Default value
java.lang.String	entityName The entity name
java.lang.String	fieldName The entity field name
boolean	formDisplay Is this parameter to be displayed via the form tool?
java.lang.String	formLabel The form label
boolean	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 name
boolean	optional Is this Parameter required or optional? Default to false, or required
boolean	overrideFormDisplay
boolean	overrideOptional
java.lang.String	stringListSuffix Parameter suffix for creating an attribute List
java.lang.String	stringMapPrefix Parameter prefix for creating an attribute Map
java.lang.String	type Paramater type
java.util.List<org.ofbiz.service.ModelParam.ModelParamValidator>	validators Validation methods

Constructor Summary

ModelParam()

ModelParam(ModelParam param)

Method Summary

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(ModelParam model)
java.lang.Object	getDefaultValue()
java.lang.String	getMode()
java.lang.String	getName()
java.lang.String	getPrimaryFailMessage(java.util.Locale locale)
java.lang.String	getShortDisplayDescription()
java.lang.String	getType()
Part	getWSDLPart(Definition def)
boolean	isIn()
boolean	isOptional()
boolean	isOut()
protected java.lang.String	java2wsdlType()
void	setDefaultValue(java.lang.String defaultValue)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final java.lang.String module

name

public java.lang.String name

Parameter name

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

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.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()

getType

public java.lang.String getType()

getMode

public java.lang.String getMode()

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)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getWSDLPart

public Part getWSDLPart(Definition def)
                 throws WSDLException

Throws:

WSDLException

java2wsdlType

protected java.lang.String java2wsdlType()
                                  throws WSDLException

Throws:

WSDLException