Area (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.domain.ModelObject
- - com.neurosys.domain.DomainObject
  - - com.neurosys.ecom.logistics.domain.AbstractArea
    - - com.neurosys.ecom.logistics.domain.Area

All Implemented Interfaces:

Displayable, IHierarchialReference<String>, AreaType, Serializable
```
@Entity
public class Area
extends AbstractArea
```
Details about Area's; around payment & Shipping to them

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Area.Key

Nested Classes
Modifier and Type	Class and Description
`static class`	`Area.Key`

Field Summary

Fields
Modifier and Type Field and Description

static String TYPE_AREACODE
- Fields inherited from class com.neurosys.ecom.logistics.domain.AbstractArea
  active, code, currency, hierarchy, language, name, type
- Fields inherited from interface com.neurosys.domain.IHierarchialReference
  ROOT

Fields
Modifier and Type	Field and Description
`static String`	`TYPE_AREACODE`

Constructor Summary

Constructors
Constructor and Description

Area()

Area(String code, String type)

Constructors
Constructor and Description
`Area()`
`Area(String code, String type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getCode()` Area Code
`String`	`getCriteriaJSON()` Project dependent JSON representing Deliver
`String`	`getId()`
`String`	`getName()` Name of Area / Locality
`String`	`getNotes()` Additional notes for Human consumption
`String`	`getParent()` Name of Parent Area / Locality
`String`	`getParentId()`
`Boolean`	`getPaymentCod()` Is COD payment option supported for this Area Code
`Boolean`	`getPaymentOnline()` Is ONLINE payment option supported for this Area Code
`Boolean`	`getShipping()` Do shipments happen to this area
`String`	`getShippingTariff()` Any additional Shipping tariff detail.
`String`	`getType()` Area Type PIN, Or some other type.
`int`	`hashCode()`
`boolean`	`isActive()` Way to switch on or off area without having to update other data to turn it off
`void`	`setActive(boolean active)` Way to switch on or off area without having to update other data to turn it off
`void`	`setCode(String code)` Area Code
`void`	`setCriteriaJSON(String criteriaJSON)` Project dependent JSON representing Deliver
`void`	`setId(String id)`
`void`	`setName(String name)` Name of Area / Locality
`void`	`setNotes(String notes)` Additional notes for Human consumption
`void`	`setParent(String parent)` Name of Parent Area / Locality
`void`	`setParentId(String parentId)`
`void`	`setPaymentCod(Boolean paymentCod)` Is COD payment option supported for this Area Code
`void`	`setPaymentOnline(Boolean paymentOnline)` Is ONLINE payment option supported for this Area Code
`void`	`setShipping(Boolean shipping)` Do shipments happen to this area
`void`	`setShippingTariff(String shippingTariff)` Any additional Shipping tariff detail.
`void`	`setType(String type)` Area Type PIN, Or some other type.
`String`	`toString()`

Methods inherited from class com.neurosys.ecom.logistics.domain.AbstractArea
getCurrency, getDisplayName, getHierarchy, getLanguage, setCurrency, setHierarchy, setLanguage

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

- Field Detail
  - TYPE_AREACODE
```
public static final String TYPE_AREACODE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Area
```
public Area()
```
  - Area
```
public Area(String code,
            String type)
```
- Method Detail
  - getCode
```
public String getCode()
```
    Area Code
    
    Specified by:
    
    getCode in interface AreaType
    
    Overrides:
    
    getCode in class AbstractArea
  - setCode
```
public void setCode(String code)
```
    Area Code
    
    Overrides:
    
    setCode in class AbstractArea
  - getType
```
public String getType()
```
    Area Type PIN, Or some other type. The type will define the format of the code
    
    Specified by:
    
    getType in interface AreaType
    
    Overrides:
    
    getType in class AbstractArea
  - setType
```
public void setType(String type)
```
    Area Type PIN, Or some other type. The type will define the format of the code
    
    Overrides:
    
    setType in class AbstractArea
  - getPaymentCod
```
public Boolean getPaymentCod()
```
    Is COD payment option supported for this Area Code
    
    Can be null:
    
    true (Project dependent)
  - setPaymentCod
```
public void setPaymentCod(Boolean paymentCod)
```
    Is COD payment option supported for this Area Code
    
    Can be null:
    
    true (Project dependent)
  - getPaymentOnline
```
public Boolean getPaymentOnline()
```
    Is ONLINE payment option supported for this Area Code
    
    Can be null:
    
    true (Project dependent)
  - setPaymentOnline
```
public void setPaymentOnline(Boolean paymentOnline)
```
    Is ONLINE payment option supported for this Area Code
    
    Can be null:
    
    true (Project dependent)
  - getShipping
```
public Boolean getShipping()
```
    Do shipments happen to this area
    
    Can be null:
    
    true (Project dependent)
  - setShipping
```
public void setShipping(Boolean shipping)
```
    Do shipments happen to this area
    
    Can be null:
    
    true (Project dependent)
  - getShippingTariff
```
public String getShippingTariff()
```
    Any additional Shipping tariff detail. Could be JSON or Number type data (Project interpretation dependent)
    
    Can be null:
    
    true
  - setShippingTariff
```
public void setShippingTariff(String shippingTariff)
```
    Any additional Shipping tariff detail. Could be JSON or Number type data (Project interpretation dependent)
    
    Can be null:
    
    true
  - isActive
```
public boolean isActive()
```
    Way to switch on or off area without having to update other data to turn it off
    
    Overrides:
    
    isActive in class AbstractArea
    
    Can be null:
    
    false
    
    Default value:
    
    true
  - setActive
```
public void setActive(boolean active)
```
    Way to switch on or off area without having to update other data to turn it off
    
    Overrides:
    
    setActive in class AbstractArea
    
    Can be null:
    
    false
    
    Default value:
    
    true
  - getCriteriaJSON
```
public String getCriteriaJSON()
```
    Project dependent JSON representing Deliver
    
    See Also:
    
    DeliveryCriteria
  - setCriteriaJSON
```
public void setCriteriaJSON(String criteriaJSON)
```
    Project dependent JSON representing Deliver
    
    See Also:
    
    DeliveryCriteria
  - getNotes
```
public String getNotes()
```
    Additional notes for Human consumption
  - setNotes
```
public void setNotes(String notes)
```
    Additional notes for Human consumption
  - getName
```
public String getName()
```
    Name of Area / Locality
    
    Specified by:
    
    getName in interface IHierarchialReference<String>
    
    Specified by:
    
    getName in interface AreaType
    
    Overrides:
    
    getName in class AbstractArea
  - setName
```
public void setName(String name)
```
    Name of Area / Locality
    
    Specified by:
    
    setName in interface IHierarchialReference<String>
    
    Overrides:
    
    setName in class AbstractArea
  - getParent
```
public String getParent()
```
    Name of Parent Area / Locality
  - setParent
```
public void setParent(String parent)
```
    Name of Parent Area / Locality
  - getId
```
public String getId()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setId
```
public void setId(String id)
```
  - getParentId
```
public String getParentId()
```
  - setParentId
```
public void setParentId(String parentId)
```

Class Area

Nested Class Summary

Field Summary

Fields inherited from class com.neurosys.ecom.logistics.domain.AbstractArea

Fields inherited from interface com.neurosys.domain.IHierarchialReference

Constructor Summary

Method Summary

Methods inherited from class com.neurosys.ecom.logistics.domain.AbstractArea

Methods inherited from class java.lang.Object

Field Detail

TYPE_AREACODE

Constructor Detail

Area

Area

Method Detail

getCode

setCode

getType

setType

getPaymentCod

setPaymentCod

getPaymentOnline

setPaymentOnline

getShipping

setShipping

getShippingTariff

setShippingTariff

isActive

setActive

getCriteriaJSON

setCriteriaJSON

getNotes

setNotes

getName

setName

getParent

setParent

getId

hashCode

equals

toString

setId

getParentId

setParentId