ModelBean (Ext Class Generator 1.0.8 API)

java.lang.Object
- ch.rasc.extclassgenerator.ModelBean

```
public class ModelBean
extends Object
```
Represents a model. This object can be used to create JS code with ModelGenerator.writeModel(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, ModelBean, OutputFormat, boolean) or ModelGenerator.generateJavascript(ModelBean, OutputFormat, boolean).

Constructor Summary

Constructors
Constructor and Description

ModelBean()

Constructors
Constructor and Description
`ModelBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAssociation(AbstractAssociation bean)` Adds one instance of `AbstractAssociation` to the internal collection of associations
`void`	`addAssociations(List<AbstractAssociation> associationsList)`
`void`	`addField(ModelFieldBean bean)` Adds one instance of `ModelFieldBean` to the internal collection of fields
`void`	`addFields(List<ModelFieldBean> modelFields)` Add all provided fields to the collection of fields
`void`	`addValidation(AbstractValidation bean)` Adds one instance of one of the subclasses of `AbstractValidation` to the internal collection of validations
`void`	`addValidations(List<AbstractValidation> fieldValidations)`
`AllDataOptionsBean`	`getAllDataOptions()`
`List<AbstractAssociation>`	`getAssociations()`
`String`	`getClientIdProperty()`
`String`	`getCreateMethod()`
`String`	`getDestroyMethod()`
`String`	`getExtend()`
`ModelFieldBean`	`getField(String fieldName)` Looks for the `ModelFieldBean` with the provided name and returns it.
`Map<String,ModelFieldBean>`	`getFields()`
`String`	`getIdentifier()`
`String`	`getIdProperty()`
`String`	`getMessageProperty()`
`String`	`getName()`
`PartialDataOptionsBean`	`getPartialDataOptions()`
`String`	`getReader()`
`String`	`getReadMethod()`
`String`	`getRootProperty()`
`String`	`getSuccessProperty()`
`String`	`getTotalProperty()`
`String`	`getUpdateMethod()`
`List<AbstractValidation>`	`getValidations()`
`String`	`getVersionProperty()`
`Boolean`	`getWriteAllFields()`
`String`	`getWriter()`
`boolean`	`isAutodetectTypes()`
`boolean`	`isClientIdPropertyAddToWriter()`
`boolean`	`isDisablePagingParameters()`
`boolean`	`isPaging()`
`void`	`setAllDataOptions(AllDataOptionsBean allDataOptions)` Configuration for the writer
`void`	`setAssociations(List<AbstractAssociation> associations)`
`void`	`setAutodetectTypes(boolean autodetectTypes)`
`void`	`setClientIdProperty(String clientIdProperty)` The name of the property a server will use to send back a client-generated id in a create or update operation.
`void`	`setClientIdPropertyAddToWriter(boolean clientIdPropertyAddToWriter)` If true configures the clientIdProperty on the proxy's writer config.
`void`	`setCreateMethod(String createMethod)` Specifies the create method.
`void`	`setDestroyMethod(String destroyMethod)` Specifies the destroy method.
`void`	`setDisablePagingParameters(boolean disablePagingParameters)` If set to true the pageParam, startParam and limitParam option of the proxy will be set to undefined.
`void`	`setExtend(String extend)` "Superclass" of this model.
`void`	`setFields(Map<String,ModelFieldBean> fields)` Overwrites all field definitions with the provided map.
`void`	`setIdentifier(String identifier)` The id generator to use for this model.
`void`	`setIdProperty(String idProperty)` Name of the id property.
`void`	`setMessageProperty(String messageProperty)` if set add to reader
`void`	`setName(String name)` "Classname" of the model.
`void`	`setPaging(boolean paging)` If true a reader config with root : 'records' will be added to the model object.
`void`	`setPartialDataOptions(PartialDataOptionsBean partialDataOptions)` Configuration for the writer
`void`	`setReader(String reader)` If set adds a reader config to the proxy object.
`void`	`setReadMethod(String readMethod)` Specifies the read method.
`void`	`setRootProperty(String rootProperty)` If set a reader config with root : 'rootProperty' (Ext JS 4) or rootProperty : 'rootProperty' (Sencha Touch 2 and Ext JS 5) will be added to the model object.
`void`	`setSuccessProperty(String successProperty)` If set add to reader
`void`	`setTotalProperty(String totalProperty)` If set add to reader
`void`	`setUpdateMethod(String updateMethod)` Specifies the update method.
`void`	`setValidations(List<AbstractValidation> validations)`
`void`	`setVersionProperty(String versionProperty)` If specified, this is the name of the property that contains the entity "version".
`void`	`setWriteAllFields(Boolean writeAllFields)` If specified the generator adds a writer config object to the proxy with writeAllFields.
`void`	`setWriter(String writer)` If set adds a writer config to the proxy object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ModelBean
```
public ModelBean()
```
- Method Detail
  - isAutodetectTypes
```
public boolean isAutodetectTypes()
```
  - setAutodetectTypes
```
public void setAutodetectTypes(boolean autodetectTypes)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
    "Classname" of the model. See Ext.data.Model .
    
    Parameters:
    
    name - new name for the model object
  - getExtend
```
public String getExtend()
```
  - setExtend
```
public void setExtend(String extend)
```
    "Superclass" of this model.
    Defaults to "Ext.data.Model"
  - getIdProperty
```
public String getIdProperty()
```
  - setIdProperty
```
public void setIdProperty(String idProperty)
```
    Name of the id property. See Ext.data.Model#idProperty.
    
    Parameters:
    
    idProperty - new value for the idProperty config option
  - getVersionProperty
```
public String getVersionProperty()
```
  - setVersionProperty
```
public void setVersionProperty(String versionProperty)
```
    If specified, this is the name of the property that contains the entity "version". The version property is used to manage a long-running transaction and allows the detection of simultaneous modification. See Ext.data.Model#versionProperty
    Defaults to null
  - getFields
```
public Map<String,ModelFieldBean> getFields()
```
  - setFields
```
public void setFields(Map<String,ModelFieldBean> fields)
```
    Overwrites all field definitions with the provided map.
    
    Parameters:
    
    fields - new collection of ModelFieldBean
  - getValidations
```
public List<AbstractValidation> getValidations()
```
  - setValidations
```
public void setValidations(List<AbstractValidation> validations)
```
  - getAssociations
```
public List<AbstractAssociation> getAssociations()
```
  - setAssociations
```
public void setAssociations(List<AbstractAssociation> associations)
```
  - addFields
```
public void addFields(List<ModelFieldBean> modelFields)
```
    Add all provided fields to the collection of fields
    
    Parameters:
    
    modelFields - collection of ModelFieldBean
  - addValidations
```
public void addValidations(List<AbstractValidation> fieldValidations)
```
  - addAssociations
```
public void addAssociations(List<AbstractAssociation> associationsList)
```
  - getField
```
public ModelFieldBean getField(String fieldName)
```
    Looks for the ModelFieldBean with the provided name and returns it.
    
    Parameters:
    
    fieldName - name of a field
    
    Returns:
    
    a ModelFieldBean or null if not found
  - addField
```
public void addField(ModelFieldBean bean)
```
    Adds one instance of ModelFieldBean to the internal collection of fields
    
    Parameters:
    
    bean - instance of ModelFieldBean
  - addValidation
```
public void addValidation(AbstractValidation bean)
```
    Adds one instance of one of the subclasses of AbstractValidation to the internal collection of validations
    
    Parameters:
    
    bean - instance of subclass of AbstractValidation
  - addAssociation
```
public void addAssociation(AbstractAssociation bean)
```
    Adds one instance of AbstractAssociation to the internal collection of associations
    
    Parameters:
    
    bean - instance of AbstractAssociation
  - isPaging
```
public boolean isPaging()
```
  - setPaging
```
public void setPaging(boolean paging)
```
    If true a reader config with root : 'records' will be added to the model object. This configuration is needed it the STORE_READ method return an instance of ExtDirectStoreResult
```
 reader : {
   root : 'records'
 }
 
```
    Parameters:
    
    paging - new value for paging
  - isDisablePagingParameters
```
public boolean isDisablePagingParameters()
```
  - setDisablePagingParameters
```
public void setDisablePagingParameters(boolean disablePagingParameters)
```
    If set to true the pageParam, startParam and limitParam option of the proxy will be set to undefined. This prevents the proxy of sending the page, start and limit parameter to the server.
```
   proxy: {
     type: 'direct',
     pageParam: undefined,
     startParam: undefined,
     limitParam: undefined,
   }
 
```
    Default value is false
  - getReadMethod
```
public String getReadMethod()
```
  - setReadMethod
```
public void setReadMethod(String readMethod)
```
    Specifies the read method. This is a ExtDirect reference in the form action.methodName. See Ext.data.proxy.Direct#api.
    If only the readMethod is specified generator will write property directFn instead.
    
    Parameters:
    
    readMethod - new value for read method
  - getCreateMethod
```
public String getCreateMethod()
```
  - setCreateMethod
```
public void setCreateMethod(String createMethod)
```
    Specifies the create method. This is a ExtDirect reference in the form action.methodName. See Ext.data.proxy.Direct#api.
    
    Parameters:
    
    createMethod - new value for create method
  - getUpdateMethod
```
public String getUpdateMethod()
```
  - setUpdateMethod
```
public void setUpdateMethod(String updateMethod)
```
    Specifies the update method. This is a ExtDirect reference in the form action.methodName. See Ext.data.proxy.Direct#api.
    
    Parameters:
    
    updateMethod - new value for update method
  - getDestroyMethod
```
public String getDestroyMethod()
```
  - setDestroyMethod
```
public void setDestroyMethod(String destroyMethod)
```
    Specifies the destroy method. This is a ExtDirect reference in the form action.methodName. See Ext.data.proxy.Direct#api.
    
    Parameters:
    
    destroyMethod - new value for destroy method
  - getMessageProperty
```
public String getMessageProperty()
```
    Returns:
    
    the messageProperty
  - setMessageProperty
```
public void setMessageProperty(String messageProperty)
```
    if set add to reader
```
 reader : {
   messageProperty : 'your property name'
 }
 
```
    It is useful to add a customized message in case of error See Ext.data.reader.Reader#messageProperty
    Parameters:
    
    messageProperty - the messageProperty to set
  - getWriter
```
public String getWriter()
```
  - setWriter
```
public void setWriter(String writer)
```
    If set adds a writer config to the proxy object.
```
   proxy: {
     type: 'direct',
     writer: {
       type: 'mywriter'
     }
   }
 
```
    See Ext.data.proxy.Proxy#writer
    Defaults to "json"
  - getReader
```
public String getReader()
```
  - setReader
```
public void setReader(String reader)
```
    If set adds a reader config to the proxy object.
```
   proxy: {
     type: 'direct',
     reader: {
       type: 'myreader'
     }
   }
 
```
    See Ext.data.proxy.Proxy#reader
    Defaults to "json"
  - getSuccessProperty
```
public String getSuccessProperty()
```
  - setSuccessProperty
```
public void setSuccessProperty(String successProperty)
```
    If set add to reader
```
 reader : {
   successProperty : 'success'
 }
 
```
    See Ext.data.reader.Reader#successProperty
    If not present default value 'success' is used.
  - getTotalProperty
```
public String getTotalProperty()
```
  - setTotalProperty
```
public void setTotalProperty(String totalProperty)
```
    If set add to reader
```
 reader : {
   totalProperty : 'total'
 }
 
```
    See Ext.data.reader.Reader#totalProperty
    If not present default value 'total' is used.
  - getRootProperty
```
public String getRootProperty()
```
  - setRootProperty
```
public void setRootProperty(String rootProperty)
```
    If set a reader config with root : 'rootProperty' (Ext JS 4) or rootProperty : 'rootProperty' (Sencha Touch 2 and Ext JS 5) will be added to the model object.
```
 reader : {
   rootProperty : 'rootProperty'
 }
 
```
    If #paging() and #rootProperty() are present #rootProperty() has precedence.
    See Ext.data.reader.Reader#root
  - getWriteAllFields
```
public Boolean getWriteAllFields()
```
  - setWriteAllFields
```
public void setWriteAllFields(Boolean writeAllFields)
```
    If specified the generator adds a writer config object to the proxy with writeAllFields.
```
   proxy: {
     type: 'direct',
     writer: {
       writeAllFields: true
     }
   }
 
```
    See Ext.data.writer.WriterView#writeAllFields
    Defaults to true
  - getIdentifier
```
public String getIdentifier()
```
  - setIdentifier
```
public void setIdentifier(String identifier)
```
    The id generator to use for this model.
    See Ext.data.Model#identifier
  - getClientIdProperty
```
public String getClientIdProperty()
```
  - setClientIdProperty
```
public void setClientIdProperty(String clientIdProperty)
```
    The name of the property a server will use to send back a client-generated id in a create or update operation.
    See Ext.data.Model#clientIdProperty
  - isClientIdPropertyAddToWriter
```
public boolean isClientIdPropertyAddToWriter()
```
  - setClientIdPropertyAddToWriter
```
public void setClientIdPropertyAddToWriter(boolean clientIdPropertyAddToWriter)
```
    If true configures the clientIdProperty on the proxy's writer config. Uses the value of clientIdProperty. If clientIdProperty is not set nothing happens.
  - getAllDataOptions
```
public AllDataOptionsBean getAllDataOptions()
```
  - setAllDataOptions
```
public void setAllDataOptions(AllDataOptionsBean allDataOptions)
```
    Configuration for the writer
    This object contains the options passed to Ext.data.Model.getData when writing Ext.data.Model.phantom records or when writeAllFields is set to true.
    See Ext.data.Model#allDataOptions
  - getPartialDataOptions
```
public PartialDataOptionsBean getPartialDataOptions()
```
  - setPartialDataOptions
```
public void setPartialDataOptions(PartialDataOptionsBean partialDataOptions)
```
    Configuration for the writer
    This object contains the options passed to Ext.data.Model.getData when writing non Ext.data.Model.phantom records or when writeAllFields is set to false.
    See Ext.data.Model#partialDataOptions

Class ModelBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModelBean

Method Detail

isAutodetectTypes

setAutodetectTypes

getName

setName

getExtend

setExtend

getIdProperty

setIdProperty

getVersionProperty

setVersionProperty

getFields

setFields

getValidations

setValidations

getAssociations

setAssociations

addFields

addValidations

addAssociations

getField

addField

addValidation

addAssociation

isPaging

setPaging

isDisablePagingParameters

setDisablePagingParameters

getReadMethod

setReadMethod

getCreateMethod

setCreateMethod

getUpdateMethod

setUpdateMethod

getDestroyMethod

setDestroyMethod

getMessageProperty

setMessageProperty

getWriter

setWriter

getReader

setReader

getSuccessProperty

setSuccessProperty

getTotalProperty

setTotalProperty

getRootProperty

setRootProperty

getWriteAllFields

setWriteAllFields

getIdentifier

setIdentifier

getClientIdProperty

setClientIdProperty

isClientIdPropertyAddToWriter

setClientIdPropertyAddToWriter

getAllDataOptions

setAllDataOptions

getPartialDataOptions

setPartialDataOptions