AdminContentSearch (KonaKartAdmin API Documentation)

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

public class AdminContentSearch
extends java.lang.Object

AdminContentSearch object for the Admin App

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`clickUrl` Click URL
`private int`	`clickUrlRule` Click URL Rule
`private int`	`contentId` Content id
`private int`	`contentTypeId` Content Type Id
`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 java.lang.String`	`custom4` custom4
`private int`	`custom4Rule` custom4 Rule
`private java.util.Date`	`dateFrom` Date from
`private int`	`dateFromRule` dateFrom Rule
`private java.util.Date`	`dateTo` Date from
`private int`	`dateToRule` dateTo Rule
`private java.lang.String`	`descriptionText` description text - search for records containing this text in any of the following AdminContentDescription fields: name1, name2, name3, name4, title, and content.
`private int`	`descriptionTextRule` descriptionText Rule
`private java.lang.Boolean`	`enabled` enabled (if null, enabled and disabled records returned; if True only enabled records returned; if False only disabled records returned)
`private int`	`expressionId` expression Id
`private int`	`objectId` Object Id
`private boolean`	`retrieveDescriptions` retrieve descriptions as well
`private java.lang.String`	`searchKey` Search Key text - search for records containing this text - can be used to find content applicable to a certain subset - such as for a certain category.
`private int`	`searchKeyRule` Search Key Rule
`private int`	`updatedBy` updatedBy

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getClickUrl()`
`int`	`getClickUrlRule()` The rule for the search.
`int`	`getContentId()`
`int`	`getContentTypeId()`
`java.lang.String`	`getCustom1()`
`int`	`getCustom1Rule()` The rule for the search.
`java.lang.String`	`getCustom2()`
`int`	`getCustom2Rule()` The rule for the search.
`java.lang.String`	`getCustom3()`
`int`	`getCustom3Rule()` The rule for the search.
`java.lang.String`	`getCustom4()`
`int`	`getCustom4Rule()` The rule for the search.
`java.util.Date`	`getDateFrom()`
`int`	`getDateFromRule()` The rule for the search.
`java.util.Date`	`getDateTo()`
`int`	`getDateToRule()` The rule for the search.
`java.lang.String`	`getDescriptionText()`
`int`	`getDescriptionTextRule()`
`java.lang.Boolean`	`getEnabled()`
`int`	`getExpressionId()`
`int`	`getObjectId()`
`java.lang.String`	`getSearchKey()`
`int`	`getSearchKeyRule()`
`int`	`getUpdatedBy()`
`boolean`	`isRetrieveDescriptions()`
`void`	`setClickUrl(java.lang.String clickUrl)`
`void`	`setClickUrlRule(int clickUrlRule)` The rule for the search.
`void`	`setContentId(int contentId)`
`void`	`setContentTypeId(int contentTypeId)`
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom1Rule(int custom1Rule)` The rule for the search.
`void`	`setCustom2(java.lang.String custom2)`
`void`	`setCustom2Rule(int custom2Rule)` The rule for the search.
`void`	`setCustom3(java.lang.String custom3)`
`void`	`setCustom3Rule(int custom3Rule)` The rule for the search.
`void`	`setCustom4(java.lang.String custom4)`
`void`	`setCustom4Rule(int custom4Rule)` The rule for the search.
`void`	`setDateFrom(java.util.Date dateFrom)`
`void`	`setDateFromRule(int dateFromRule)` The rule for the search.
`void`	`setDateTo(java.util.Date dateTo)`
`void`	`setDateToRule(int dateToRule)` The rule for the search.
`void`	`setDescriptionText(java.lang.String descriptionText)` Search for records containing this text in any of the following AdminContentDescription fields: name1, name2, name3, name4, title, and content.
`void`	`setDescriptionTextRule(int descriptionTextRule)` Search for records containing this text in any of the ContentDescription fields (such as name1, name2, title, content fields).
`void`	`setEnabled(java.lang.Boolean enabled)`
`void`	`setExpressionId(int expressionId)`
`void`	`setObjectId(int objectId)`
`void`	`setRetrieveDescriptions(boolean retrieveDescriptions)`
`void`	`setSearchKey(java.lang.String searchKey)`
`void`	`setSearchKeyRule(int searchKeyRule)`
`void`	`setUpdatedBy(int updatedBy)`
`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
  - contentId
```
private int contentId
```
    Content id
  - contentTypeId
```
private int contentTypeId
```
    Content Type Id
  - objectId
```
private int objectId
```
    Object Id
  - clickUrl
```
private java.lang.String clickUrl
```
    Click URL
  - clickUrlRule
```
private int clickUrlRule
```
    Click URL Rule
  - dateFrom
```
private java.util.Date dateFrom
```
    Date from
  - dateFromRule
```
private int dateFromRule
```
    dateFrom Rule
  - dateTo
```
private java.util.Date dateTo
```
    Date from
  - dateToRule
```
private int dateToRule
```
    dateTo Rule
  - enabled
```
private java.lang.Boolean enabled
```
    enabled (if null, enabled and disabled records returned; if True only enabled records returned; if False only disabled records returned)
  - expressionId
```
private int expressionId
```
    expression Id
  - descriptionText
```
private java.lang.String descriptionText
```
    description text - search for records containing this text in any of the following AdminContentDescription fields: name1, name2, name3, name4, title, and content.
  - descriptionTextRule
```
private int descriptionTextRule
```
    descriptionText Rule
  - searchKey
```
private java.lang.String searchKey
```
    Search Key text - search for records containing this text - can be used to find content applicable to a certain subset - such as for a certain category.
  - searchKeyRule
```
private int searchKeyRule
```
    Search Key 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
  - custom4
```
private java.lang.String custom4
```
    custom4
  - custom4Rule
```
private int custom4Rule
```
    custom4 Rule
  - updatedBy
```
private int updatedBy
```
    updatedBy
  - retrieveDescriptions
```
private boolean retrieveDescriptions
```
    retrieve descriptions as well
- Constructor Detail
  - AdminContentSearch
```
public AdminContentSearch()
```
    Instantiates an AdminContentSearch object - a requirement for a bean class
  - AdminContentSearch
```
public AdminContentSearch(com.workingdogs.village.Record r,
                          com.konakart.db.KKCriteria c)
                   throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the AdminContentSearch 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 this object.
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing the attributes of this object.
  - getContentId
```
public int getContentId()
```
    Returns:
    
    the contentId
  - setContentId
```
public void setContentId(int contentId)
```
    Parameters:
    
    contentId - the contentId to set
  - getContentTypeId
```
public int getContentTypeId()
```
    Returns:
    
    the contentTypeId
  - setContentTypeId
```
public void setContentTypeId(int contentTypeId)
```
    Parameters:
    
    contentTypeId - the contentTypeId to set
  - getObjectId
```
public int getObjectId()
```
    Returns:
    
    the objectId
  - setObjectId
```
public void setObjectId(int objectId)
```
    Parameters:
    
    objectId - the objectId to set
  - getClickUrl
```
public java.lang.String getClickUrl()
```
    Returns:
    
    the clickUrl
  - setClickUrl
```
public void setClickUrl(java.lang.String clickUrl)
```
    Parameters:
    
    clickUrl - the clickUrl to set
  - getClickUrlRule
```
public int getClickUrlRule()
```
    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 clickUrlRule
  - setClickUrlRule
```
public void setClickUrlRule(int clickUrlRule)
```
    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:
    
    clickUrlRule - the clickUrlRule to set
  - getDateFrom
```
public java.util.Date getDateFrom()
```
    Returns:
    
    the dateFrom
  - setDateFrom
```
public void setDateFrom(java.util.Date dateFrom)
```
    Parameters:
    
    dateFrom - the dateFrom to set
  - getDateFromRule
```
public int getDateFromRule()
```
    The rule for the search. Valid values are:
    - KKConstants.SEARCH_GREATER_THAN
    - KKConstants.SEARCH_GREATER_EQUAL
    - KKConstants.SEARCH_LESS_THAN
    - KKConstants.SEARCH_LESS_EQUAL
    - KKConstants.SEARCH_EQUAL
    Returns:
    
    the dateFromRule
  - setDateFromRule
```
public void setDateFromRule(int dateFromRule)
```
    The rule for the search. Valid values are:
    - KKConstants.SEARCH_GREATER_THAN
    - KKConstants.SEARCH_GREATER_EQUAL
    - KKConstants.SEARCH_LESS_THAN
    - KKConstants.SEARCH_LESS_EQUAL
    - KKConstants.SEARCH_EQUAL
    Parameters:
    
    dateFromRule - the dateFromRule to set
  - getDateTo
```
public java.util.Date getDateTo()
```
    Returns:
    
    the dateTo
  - setDateTo
```
public void setDateTo(java.util.Date dateTo)
```
    Parameters:
    
    dateTo - the dateTo to set
  - getDateToRule
```
public int getDateToRule()
```
    The rule for the search. Valid values are:
    - KKConstants.SEARCH_GREATER_THAN
    - KKConstants.SEARCH_GREATER_EQUAL
    - KKConstants.SEARCH_LESS_THAN
    - KKConstants.SEARCH_LESS_EQUAL
    - KKConstants.SEARCH_EQUAL
    Returns:
    
    the dateToRule
  - setDateToRule
```
public void setDateToRule(int dateToRule)
```
    The rule for the search. Valid values are:
    - KKConstants.SEARCH_GREATER_THAN
    - KKConstants.SEARCH_GREATER_EQUAL
    - KKConstants.SEARCH_LESS_THAN
    - KKConstants.SEARCH_LESS_EQUAL
    - KKConstants.SEARCH_EQUAL
    Parameters:
    
    dateToRule - the dateToRule to set
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
    Returns:
    
    the enabled
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Parameters:
    
    enabled - the enabled to set
  - getExpressionId
```
public int getExpressionId()
```
    Returns:
    
    the expressionId
  - setExpressionId
```
public void setExpressionId(int expressionId)
```
    Parameters:
    
    expressionId - the expressionId 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
  - getCustom2
```
public java.lang.String getCustom2()
```
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - the custom2 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
  - getCustom4
```
public java.lang.String getCustom4()
```
    Returns:
    
    the custom4
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - the custom4 to set
  - getCustom1Rule
```
public int getCustom1Rule()
```
    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 custom1Rule
  - setCustom1Rule
```
public void setCustom1Rule(int custom1Rule)
```
    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:
    
    custom1Rule - the custom1Rule to set
  - getCustom2Rule
```
public int getCustom2Rule()
```
    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 custom2Rule
  - setCustom2Rule
```
public void setCustom2Rule(int custom2Rule)
```
    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:
    
    custom2Rule - the custom2Rule to set
  - getCustom3Rule
```
public int getCustom3Rule()
```
    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 custom3Rule
  - setCustom3Rule
```
public void setCustom3Rule(int custom3Rule)
```
    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:
    
    custom3Rule - the custom3Rule to set
  - getCustom4Rule
```
public int getCustom4Rule()
```
    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 custom4Rule
  - setCustom4Rule
```
public void setCustom4Rule(int custom4Rule)
```
    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:
    
    custom4Rule - the custom4Rule to set
  - getUpdatedBy
```
public int getUpdatedBy()
```
    Returns:
    
    the updatedBy
  - setUpdatedBy
```
public void setUpdatedBy(int updatedBy)
```
    Parameters:
    
    updatedBy - the updatedBy to set
  - getDescriptionText
```
public java.lang.String getDescriptionText()
```
    Returns:
    
    the descriptionText
  - setDescriptionText
```
public void setDescriptionText(java.lang.String descriptionText)
```
    Search for records containing this text in any of the following AdminContentDescription fields: name1, name2, name3, name4, title, and content.
    
    Parameters:
    
    descriptionText - the descriptionText to set
  - getDescriptionTextRule
```
public int getDescriptionTextRule()
```
    Returns:
    
    the descriptionTextRule
  - setDescriptionTextRule
```
public void setDescriptionTextRule(int descriptionTextRule)
```
    Search for records containing this text in any of the ContentDescription fields (such as name1, name2, title, content fields). 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:
    
    descriptionTextRule - the descriptionTextRule to set
  - isRetrieveDescriptions
```
public boolean isRetrieveDescriptions()
```
    Returns:
    
    the retrieveDescriptions
  - setRetrieveDescriptions
```
public void setRetrieveDescriptions(boolean retrieveDescriptions)
```
    Parameters:
    
    retrieveDescriptions - the retrieveDescriptions to set
  - getSearchKey
```
public java.lang.String getSearchKey()
```
    Returns:
    
    the searchKey
  - setSearchKey
```
public void setSearchKey(java.lang.String searchKey)
```
    Parameters:
    
    searchKey - the searchKey to set
  - getSearchKeyRule
```
public int getSearchKeyRule()
```
    Returns:
    
    the searchKeyRule
  - setSearchKeyRule
```
public void setSearchKeyRule(int searchKeyRule)
```
    Parameters:
    
    searchKeyRule - the searchKeyRule to set

Class AdminContentSearch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

contentId

contentTypeId

objectId

clickUrl

clickUrlRule

dateFrom

dateFromRule

dateTo

dateToRule

enabled

expressionId

descriptionText

descriptionTextRule

searchKey

searchKeyRule

custom1

custom1Rule

custom2

custom2Rule

custom3

custom3Rule

custom4

custom4Rule

updatedBy

retrieveDescriptions

Constructor Detail

AdminContentSearch

AdminContentSearch

Method Detail

toString

toStringBrief

getContentId

setContentId

getContentTypeId

setContentTypeId

getObjectId

setObjectId

getClickUrl

setClickUrl

getClickUrlRule

setClickUrlRule

getDateFrom

setDateFrom

getDateFromRule

setDateFromRule

getDateTo

setDateTo

getDateToRule

setDateToRule

getEnabled

setEnabled

getExpressionId

setExpressionId

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom1Rule

setCustom1Rule

getCustom2Rule

setCustom2Rule

getCustom3Rule

setCustom3Rule

getCustom4Rule

setCustom4Rule

getUpdatedBy

setUpdatedBy

getDescriptionText

setDescriptionText

getDescriptionTextRule