AdminCouponSearch (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.app.AdminCouponSearch

public class AdminCouponSearch
extends java.lang.Object

Coupon search object for the Admin App

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`couponCode` The value of the coupon code
`private int`	`couponCodeRule` The value of the coupon code rule
`private java.lang.String`	`custom1` custom1
`private int`	`custom1Rule` custom1 Rule
`private java.lang.String`	`custom2` custom2
`private int`	`custom2Rule` custom2 Rule
`private java.lang.String`	`custom3` custom3
`private int`	`custom3Rule` custom3 Rule
`private int`	`id` The value for the couponId field
`private java.lang.String`	`name` Name
`private int`	`nameRule` Name Rule
`private java.lang.String`	`orderBy` orderBy
`private int`	`promotionId` promotion Id

Constructor Summary

Constructors
Constructor and Description
`AdminCouponSearch()` Instantiates an AdminCouponSearch object - a requirement for a bean class
`AdminCouponSearch(com.workingdogs.village.Record r, com.konakart.db.KKCriteria c)` Instantiates the attributes of the AdminLanguageSearch object from a Record object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCouponCode()`
`int`	`getCouponCodeRule()` The rule for the search.
`java.lang.String`	`getCustom1()`
`int`	`getCustom1Rule()`
`java.lang.String`	`getCustom2()`
`int`	`getCustom2Rule()`
`java.lang.String`	`getCustom3()`
`int`	`getCustom3Rule()`
`int`	`getId()`
`java.lang.String`	`getName()`
`int`	`getNameRule()` The rule for the search.
`java.lang.String`	`getOrderBy()`
`int`	`getPromotionId()`
`void`	`setCouponCode(java.lang.String couponCode)`
`void`	`setCouponCodeRule(int couponCodeRule)` The rule for the search.
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom1Rule(int custom1Rule)`
`void`	`setCustom2(java.lang.String custom2)`
`void`	`setCustom2Rule(int custom2Rule)`
`void`	`setCustom3(java.lang.String custom3)`
`void`	`setCustom3Rule(int custom3Rule)`
`void`	`setId(int id)`
`void`	`setName(java.lang.String name)`
`void`	`setNameRule(int nameRule)` The rule for the search.
`void`	`setOrderBy(java.lang.String orderBy)`
`void`	`setPromotionId(int promotionId)`
`java.lang.String`	`toString()`

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

- Field Detail
  - id
```
private int id
```
    The value for the couponId field
  - name
```
private java.lang.String name
```
    Name
  - nameRule
```
private int nameRule
```
    Name Rule
  - couponCode
```
private java.lang.String couponCode
```
    The value of the coupon code
  - couponCodeRule
```
private int couponCodeRule
```
    The value of the coupon code rule
  - custom1
```
private java.lang.String custom1
```
    custom1
  - custom1Rule
```
private int custom1Rule
```
    custom1 Rule
  - custom2
```
private java.lang.String custom2
```
    custom2
  - custom2Rule
```
private int custom2Rule
```
    custom2 Rule
  - custom3
```
private java.lang.String custom3
```
    custom3
  - custom3Rule
```
private int custom3Rule
```
    custom3 Rule
  - orderBy
```
private java.lang.String orderBy
```
    orderBy
  - promotionId
```
private int promotionId
```
    promotion Id
- Constructor Detail
  - AdminCouponSearch
```
public AdminCouponSearch()
```
    Instantiates an AdminCouponSearch object - a requirement for a bean class
  - AdminCouponSearch
```
public AdminCouponSearch(com.workingdogs.village.Record r,
                         com.konakart.db.KKCriteria c)
                  throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the AdminLanguageSearch object from a Record object
    
    Parameters:
    
    r - Record containing data
    
    c - Criteria containing column names
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the PromotionSearch object.
  - getCouponCode
```
public java.lang.String getCouponCode()
```
    Returns:
    
    Returns the couponCode.
  - setCouponCode
```
public void setCouponCode(java.lang.String couponCode)
```
    Parameters:
    
    couponCode - The couponCode to set.
  - getId
```
public int getId()
```
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - The id to set.
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    Returns the name.
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    
    name - The name to set.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    Returns:
    
    Returns the orderBy.
  - setOrderBy
```
public void setOrderBy(java.lang.String orderBy)
```
    Parameters:
    
    orderBy - The orderBy to set.
  - getPromotionId
```
public int getPromotionId()
```
    Returns:
    
    Returns the promotionId.
  - setPromotionId
```
public void setPromotionId(int promotionId)
```
    Parameters:
    
    promotionId - The promotionId to set.
  - getNameRule
```
public int getNameRule()
```
    The rule for the search. Valid values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the nameRule
  - setNameRule
```
public void setNameRule(int nameRule)
```
    The rule for the search. Valid values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    nameRule - the nameRule to set
  - getCouponCodeRule
```
public int getCouponCodeRule()
```
    The rule for the search. Valid values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the couponCodeRule
  - setCouponCodeRule
```
public void setCouponCodeRule(int couponCodeRule)
```
    The rule for the search. Valid values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    couponCodeRule - the couponCodeRule to set
  - getCustom1
```
public java.lang.String getCustom1()
```
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom1Rule
```
public int getCustom1Rule()
```
    Returns:
    
    the custom1Rule
  - setCustom1Rule
```
public void setCustom1Rule(int custom1Rule)
```
    Parameters:
    
    custom1Rule - the custom1Rule to set
  - getCustom2
```
public java.lang.String getCustom2()
```
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom2Rule
```
public int getCustom2Rule()
```
    Returns:
    
    the custom2Rule
  - setCustom2Rule
```
public void setCustom2Rule(int custom2Rule)
```
    Parameters:
    
    custom2Rule - the custom2Rule to set
  - getCustom3
```
public java.lang.String getCustom3()
```
    Returns:
    
    the custom3
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom3Rule
```
public int getCustom3Rule()
```
    Returns:
    
    the custom3Rule
  - setCustom3Rule
```
public void setCustom3Rule(int custom3Rule)
```
    Parameters:
    
    custom3Rule - the custom3Rule to set

Class AdminCouponSearch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

name

nameRule

couponCode

couponCodeRule

custom1

custom1Rule

custom2

custom2Rule

custom3

custom3Rule

orderBy

promotionId

Constructor Detail

AdminCouponSearch

AdminCouponSearch

Method Detail

toString

getCouponCode

setCouponCode

getId

setId

getName

setName

getOrderBy

setOrderBy

getPromotionId

setPromotionId

getNameRule

setNameRule

getCouponCodeRule

setCouponCodeRule

getCustom1

setCustom1

getCustom1Rule

setCustom1Rule

getCustom2

setCustom2

getCustom2Rule

setCustom2Rule

getCustom3

setCustom3

getCustom3Rule

setCustom3Rule