Promotion (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.domain.ModelObject
- - com.neurosys.domain.DomainObject
  - - com.neurosys.ecom.orders.domain.Promotion

All Implemented Interfaces:

Serializable
```
@Entity
public class Promotion
extends DomainObject
```
Define any promotions or discounts

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Promotion.Type
The type, like some CAMPAIGN, DISCOUNT, USER COUPON, REFUND etc.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Promotion.Type` The type, like some CAMPAIGN, DISCOUNT, USER COUPON, REFUND etc.

Constructor Summary

Constructors
Constructor and Description

Promotion()

Promotion(Promotion.Type type, String name)

Constructors
Constructor and Description
`Promotion()`
`Promotion(Promotion.Type type, String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAmountJson()` Details about the Discount/Promotion itself like Amount, Unit, Currency etc. This JSON is intended to be App specific where the `PromotionStrategy` can interpret the JSON criteria
`String`	`getCriteriaJson()` Any additional Data to describe the Promotion meta-data criteria like who, how many times can the same user use it, how is a user identified, and how people are eligible for it etc. This JSON is intended to be App specific where the `PromotionStrategy` can interpret the JSON criteria
`String`	`getDescription()` Description for reference purposes
`String`	`getDisplayName()` User friendly name for the promotion
`String`	`getName()` A name to identify the promotion / campaign Note: Details and rule of how the promotion impacts Quantity for any given user or type of user can be defined by the application in the form of Rules etc.
`Promotion.Type`	`getType()` The type, like some CAMPAIGN, DISCOUNT, USER COUPON, REFUND etc.
`Date`	`getValidityEnd()` The validity start Date range and end date range
`Date`	`getValidityStart()` The validity start Date range and end date range
`int`	`hashCode()`
`boolean`	`isActive()` Is the promotion currently marked active Useful if we want to disable the promotion temp.
`void`	`setActive(boolean active)` Is the promotion currently marked active Useful if we want to disable the promotion temp.
`void`	`setAmountJson(String amountJson)` Details about the Discount/Promotion itself like Amount, Unit, Currency etc. This JSON is intended to be App specific where the `PromotionStrategy` can interpret the JSON criteria
`void`	`setCriteriaJson(String criteriaJson)` Any additional Data to describe the Promotion meta-data criteria like who, how many times can the same user use it, how is a user identified, and how people are eligible for it etc. This JSON is intended to be App specific where the `PromotionStrategy` can interpret the JSON criteria
`void`	`setDescription(String description)` Description for reference purposes
`void`	`setDisplayName(String displayName)` User friendly name for the promotion
`void`	`setName(String name)` A name to identify the promotion / campaign Note: Details and rule of how the promotion impacts Quantity for any given user or type of user can be defined by the application in the form of Rules etc.
`void`	`setType(Promotion.Type type)` The type, like some CAMPAIGN, DISCOUNT, USER COUPON, REFUND etc.
`void`	`setValidityEnd(Date validityEnd)` The validity start Date range and end date range
`void`	`setValidityStart(Date validityStart)` The validity start Date range and end date range
`String`	`toString()`

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

- Constructor Detail
  - Promotion
```
public Promotion()
```
  - Promotion
```
public Promotion(Promotion.Type type,
                 String name)
```
- Method Detail
  - getName
```
public String getName()
```
    A name to identify the promotion / campaign
    
    Note: Details and rule of how the promotion impacts Quantity for any given user or type of user can be defined by the application in the form of Rules etc. Thats the job of the SaleStrategy
    
    Can be null:
    
    false
  - setName
```
public void setName(String name)
```
    A name to identify the promotion / campaign
    
    Note: Details and rule of how the promotion impacts Quantity for any given user or type of user can be defined by the application in the form of Rules etc. Thats the job of the SaleStrategy
    
    Can be null:
    
    false
  - getValidityStart
```
public Date getValidityStart()
```
    The validity start Date range and end date range
    
    Can be null:
    
    true
  - setValidityStart
```
public void setValidityStart(Date validityStart)
```
    The validity start Date range and end date range
    
    Can be null:
    
    true
  - getValidityEnd
```
public Date getValidityEnd()
```
    The validity start Date range and end date range
    
    Can be null:
    
    true
  - setValidityEnd
```
public void setValidityEnd(Date validityEnd)
```
    The validity start Date range and end date range
    
    Can be null:
    
    true
  - isActive
```
public boolean isActive()
```
    Is the promotion currently marked active
    Useful if we want to disable the promotion temp.
    
    Default value:
    
    true
  - setActive
```
public void setActive(boolean active)
```
    Is the promotion currently marked active
    Useful if we want to disable the promotion temp.
    
    Default value:
    
    true
  - getType
```
public Promotion.Type getType()
```
    The type, like some CAMPAIGN, DISCOUNT, USER COUPON, REFUND etc.
    
    Note: Details and rule of how the promotion impacts Quantity for any given user or type of user can be defined by the application in the form of Rules etc. Thats the job of the SaleStrategy
    
    Can be null:
    
    true
  - setType
```
public void setType(Promotion.Type type)
```
    The type, like some CAMPAIGN, DISCOUNT, USER COUPON, REFUND etc.
    
    Note: Details and rule of how the promotion impacts Quantity for any given user or type of user can be defined by the application in the form of Rules etc. Thats the job of the SaleStrategy
    
    Can be null:
    
    true
  - getCriteriaJson
```
public String getCriteriaJson()
```
    Any additional Data to describe the Promotion meta-data criteria like who, how many times can the same user use it, how is a user identified, and how people are eligible for it etc.
    This JSON is intended to be App specific where the PromotionStrategy can interpret the JSON criteria
  - setCriteriaJson
```
public void setCriteriaJson(String criteriaJson)
```
    Any additional Data to describe the Promotion meta-data criteria like who, how many times can the same user use it, how is a user identified, and how people are eligible for it etc.
    This JSON is intended to be App specific where the PromotionStrategy can interpret the JSON criteria
  - getAmountJson
```
public String getAmountJson()
```
    Details about the Discount/Promotion itself like Amount, Unit, Currency etc.
    This JSON is intended to be App specific where the PromotionStrategy can interpret the JSON criteria
  - setAmountJson
```
public void setAmountJson(String amountJson)
```
    Details about the Discount/Promotion itself like Amount, Unit, Currency etc.
    This JSON is intended to be App specific where the PromotionStrategy can interpret the JSON criteria
  - getDisplayName
```
public String getDisplayName()
```
    User friendly name for the promotion
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    User friendly name for the promotion
  - getDescription
```
public String getDescription()
```
    Description for reference purposes
  - setDescription
```
public void setDescription(String description)
```
    Description for reference purposes
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Promotion

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Promotion

Promotion

Method Detail

getName

setName

getValidityStart

setValidityStart

getValidityEnd

setValidityEnd

isActive

setActive

getType

setType

getCriteriaJson

setCriteriaJson

getAmountJson

setAmountJson

getDisplayName

setDisplayName

getDescription

setDescription

equals

hashCode

toString