AdminPromotionSearch (KonaKartAdmin API Documentation)

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

public class AdminPromotionSearch
extends java.lang.Object

Promotion search object for the Admin App

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.Boolean`	`active` When not set to null, it's used to return only active or inactive promotions.
`private java.lang.Boolean`	`cumulative` cumulative
`private java.util.Date`	`endDate` end date
`private int`	`id` id
`private java.lang.String`	`name` name
`private int`	`nameRule` name rule
`private java.lang.String`	`orderBy` orderBy
`private java.lang.String`	`orderTotalCode` order Total Code
`private int`	`orderTotalCodeRule` order Total Code rule
`private java.lang.Boolean`	`requiresCoupon` requires Coupon
`private java.util.Date`	`startDate` start date

Constructor Summary

Constructors
Constructor and Description
`AdminPromotionSearch()` Instantiates an AdminPromotionSearch object - a requirement for a bean class
`AdminPromotionSearch(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.Boolean`	`getActive()` When not set to null, it's used to return only active or inactive promotions.
`java.lang.Boolean`	`getCumulative()`
`java.util.Date`	`getEndDate()`
`int`	`getId()`
`java.lang.String`	`getName()`
`int`	`getNameRule()` The rule for the search.
`java.lang.String`	`getOrderBy()`
`java.lang.String`	`getOrderTotalCode()`
`int`	`getOrderTotalCodeRule()` The rule for the search.
`java.lang.Boolean`	`getRequiresCoupon()`
`java.util.Date`	`getStartDate()`
`void`	`setActive(java.lang.Boolean active)` When not set to null, it's used to return only active or inactive promotions.
`void`	`setCumulative(java.lang.Boolean cumulative)`
`void`	`setEndDate(java.util.Date endDate)`
`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`	`setOrderTotalCode(java.lang.String orderTotalCode)`
`void`	`setOrderTotalCodeRule(int orderTotalCodeRule)` The rule for the search.
`void`	`setRequiresCoupon(java.lang.Boolean requiresCoupon)`
`void`	`setStartDate(java.util.Date startDate)`
`java.lang.String`	`toString()`
`java.lang.String`	`toStringBrief()`

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

- Field Detail
  - active
```
private java.lang.Boolean active
```
    When not set to null, it's used to return only active or inactive promotions. We look at the following attributes in order to determine whether a promotion is active or not.
    - Active flag
    - Start and end dates if not null
    - Max use if > -1
  - startDate
```
private java.util.Date startDate
```
    start date
  - endDate
```
private java.util.Date endDate
```
    end date
  - cumulative
```
private java.lang.Boolean cumulative
```
    cumulative
  - name
```
private java.lang.String name
```
    name
  - nameRule
```
private int nameRule
```
    name rule
  - orderTotalCode
```
private java.lang.String orderTotalCode
```
    order Total Code
  - orderTotalCodeRule
```
private int orderTotalCodeRule
```
    order Total Code rule
  - requiresCoupon
```
private java.lang.Boolean requiresCoupon
```
    requires Coupon
  - orderBy
```
private java.lang.String orderBy
```
    orderBy
  - id
```
private int id
```
    id
- Constructor Detail
  - AdminPromotionSearch
```
public AdminPromotionSearch()
```
    Instantiates an AdminPromotionSearch object - a requirement for a bean class
  - AdminPromotionSearch
```
public AdminPromotionSearch(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.
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing the attributes of the PromotionSearch object.
  - getActive
```
public java.lang.Boolean getActive()
```
    When not set to null, it's used to return only active or inactive promotions. We look at the following attributes in order to determine whether a promotion is active or not.
    - Active flag
    - Start and end dates if not null
    - Max use if > -1
    Returns:
    
    Returns the active.
  - setActive
```
public void setActive(java.lang.Boolean active)
```
    When not set to null, it's used to return only active or inactive promotions. We look at the following attributes in order to determine whether a promotion is active or not.
    - Active flag
    - Start and end dates if not null
    - Max use if > -1
    Parameters:
    
    active - The active to set.
  - getCumulative
```
public java.lang.Boolean getCumulative()
```
    Returns:
    
    Returns the cumulative.
  - setCumulative
```
public void setCumulative(java.lang.Boolean cumulative)
```
    Parameters:
    
    cumulative - The cumulative to set.
  - getEndDate
```
public java.util.Date getEndDate()
```
    Returns:
    
    Returns the endDate.
  - setEndDate
```
public void setEndDate(java.util.Date endDate)
```
    Parameters:
    
    endDate - The endDate 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.
  - getOrderTotalCode
```
public java.lang.String getOrderTotalCode()
```
    Returns:
    
    Returns the orderTotalCode.
  - setOrderTotalCode
```
public void setOrderTotalCode(java.lang.String orderTotalCode)
```
    Parameters:
    
    orderTotalCode - The orderTotalCode to set.
  - getRequiresCoupon
```
public java.lang.Boolean getRequiresCoupon()
```
    Returns:
    
    Returns the requiresCoupon.
  - setRequiresCoupon
```
public void setRequiresCoupon(java.lang.Boolean requiresCoupon)
```
    Parameters:
    
    requiresCoupon - The requiresCoupon to set.
  - getStartDate
```
public java.util.Date getStartDate()
```
    Returns:
    
    Returns the startDate.
  - setStartDate
```
public void setStartDate(java.util.Date startDate)
```
    Parameters:
    
    startDate - The startDate 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.
  - getId
```
public int getId()
```
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - The id 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
  - getOrderTotalCodeRule
```
public int getOrderTotalCodeRule()
```
    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 orderTotalCodeRule
  - setOrderTotalCodeRule
```
public void setOrderTotalCodeRule(int orderTotalCodeRule)
```
    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:
    
    orderTotalCodeRule - the orderTotalCodeRule to set

Class AdminPromotionSearch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

active

startDate

endDate

cumulative

name

nameRule

orderTotalCode

orderTotalCodeRule

requiresCoupon

orderBy

id

Constructor Detail

AdminPromotionSearch

AdminPromotionSearch

Method Detail

toString

toStringBrief

getActive

setActive

getCumulative

setCumulative

getEndDate

setEndDate

getName

setName

getOrderTotalCode

setOrderTotalCode

getRequiresCoupon

setRequiresCoupon

getStartDate

setStartDate

getOrderBy

setOrderBy

getId

setId

getNameRule

setNameRule

getOrderTotalCodeRule

setOrderTotalCodeRule