CollateralSearchListDataBean

java.lang.Object
- com.ibm.commerce.tools.campaigns.search.beans.CollateralSearchListDataBean

All Implemented Interfaces:

CommandDataBean, DataBean, InputDataBean, java.io.Serializable
```
public class CollateralSearchListDataBean
extends java.lang.Object
implements CommandDataBean
```
This utility class uses Query framework to search a collateral based on supplied predicates.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.
- Fields inherited from interface com.ibm.commerce.beans.DataBean
  emptyString

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

CollateralSearchListDataBean()

Constructors
Constructor and Description
`CollateralSearchListDataBean()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCommandInterfaceName()` Gets the command interface name.
`CampaignCollateralDataBean[]`	`getCpgnCollDataBeans()` Gets all the collateral data beans that matches this search.
`java.lang.String`	`getFileName()` Gets the value of the File Name search criteria used in the search.
`java.lang.String`	`getFileNameOperator()` Gets the operator of the File Name search criteria used in the search.
`java.lang.String`	`getIniPos()` Gets the start position for result set cursor.
`java.lang.String`	`getMaxResult()` Gets the maximum number of results to be returned in the search.
`java.lang.String`	`getMktTxt()` Gets the value of the Marketing Text search criteria used in the search.
`java.lang.String`	`getMktTxtOperator()` Gets the operator of the Marketing Text search criteria used in the search.
`java.lang.String`	`getName()` Gets the value of the Collateral Name search criteria used in the search.
`java.lang.String`	`getNameOperator()` Gets the operator of the Collateral Name search criteria used in the search.
`java.lang.String`	`getOrderBy()` Gets the value of the order by clause used in the search query.
`TypedProperty`	`getRequestProperties()` Returns the request properties of the databean.
`java.lang.String`	`getURL()` Gets the value of the Collateral URL search criteria used in the search.
`java.lang.String`	`getURLOperator()` Gets the operator of the Collateral URL search criteria used in the search.
`void`	`setCommandInterfaceName(java.lang.String ifname)` Sets the command interface name.
`void`	`setCpgnCollDataBeans(CampaignCollateralDataBean[] beans)` Sets the array of collateral beans that is returned by this search command.
`void`	`setFileName(java.lang.String fileNam)` Sets the value of the File Name search criteria used in the search.
`void`	`setFileNameOperator(java.lang.String fileNameOptr)` Sets the operator of the File Name search criteria used in the search.
`void`	`setIniPos(java.lang.String iniPosition)` Sets the start position for result set cursor.
`void`	`setMaxResult(java.lang.String maxRes)` Sets the maximum number of results to be returned in the search.
`void`	`setMktTxt(java.lang.String mktText)` Sets the value of the Marketing Text search criteria used in the search.
`void`	`setMktTxtOperator(java.lang.String mktTxtOptr)` Sets the operator of the Marketing Text search criteria used in the search.
`void`	`setName(java.lang.String nam)` Sets the value of the Collateral Name search criteria used in the search.
`void`	`setNameOperator(java.lang.String nameOptr)` Sets the operator of the Collateral Name search criteria used in the search.
`void`	`setOrderBy(java.lang.String string)` Sets the value of the order by clause used in the search query.
`void`	`setRequestProperties(TypedProperty param)` Set the requestProperties associated with the data bean.
`void`	`setURL(java.lang.String ClkURL)` Sets the value of the Collateral URL search criteria used in the search.
`void`	`setURLOperator(java.lang.String URLOptr)` Sets the operator of the Collateral URL search criteria used in the search.

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

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CollateralSearchListDataBean
```
public CollateralSearchListDataBean()
```
- Method Detail
  - getFileName
```
public java.lang.String getFileName()
```
    Gets the value of the File Name search criteria used in the search.
    
    Returns:
    
    The value of the File Name search criteria used in the search.
  - getMktTxt
```
public java.lang.String getMktTxt()
```
    Gets the value of the Marketing Text search criteria used in the search.
    
    Returns:
    
    The value of the Marketing Text search criteria used in the search.
  - getName
```
public java.lang.String getName()
```
    Gets the value of the Collateral Name search criteria used in the search.
    
    Returns:
    
    The value of the Collateral Name search criteria used in the search.
  - setFileName
```
public void setFileName(java.lang.String fileNam)
```
    Sets the value of the File Name search criteria used in the search.
    
    Parameters:
    
    fileNam - The value of the File Name search criteria used in the search.
  - setMktTxt
```
public void setMktTxt(java.lang.String mktText)
```
    Sets the value of the Marketing Text search criteria used in the search.
    
    Parameters:
    
    mktText - The value of the Marketing Text search criteria used in the search.
  - setName
```
public void setName(java.lang.String nam)
```
    Sets the value of the Collateral Name search criteria used in the search.
    
    Parameters:
    
    nam - The value of the Collateral Name search criteria used in the search.
  - getFileNameOperator
```
public java.lang.String getFileNameOperator()
```
    Gets the operator of the File Name search criteria used in the search.
    
    Returns:
    
    The operator of the File Name search criteria used in the search.
  - getMktTxtOperator
```
public java.lang.String getMktTxtOperator()
```
    Gets the operator of the Marketing Text search criteria used in the search.
    
    Returns:
    
    The operator of the Marketing Text search criteria used in the search.
  - getNameOperator
```
public java.lang.String getNameOperator()
```
    Gets the operator of the Collateral Name search criteria used in the search.
    
    Returns:
    
    The operator of the Collateral Name search criteria used in the search.
  - getURLOperator
```
public java.lang.String getURLOperator()
```
    Gets the operator of the Collateral URL search criteria used in the search.
    
    Returns:
    
    The operator of the Collateral URL search criteria used in the search.
  - setFileNameOperator
```
public void setFileNameOperator(java.lang.String fileNameOptr)
```
    Sets the operator of the File Name search criteria used in the search.
    
    Parameters:
    
    fileNameOptr - The operator of the File Name search criteria used in the search.
  - setMktTxtOperator
```
public void setMktTxtOperator(java.lang.String mktTxtOptr)
```
    Sets the operator of the Marketing Text search criteria used in the search.
    
    Parameters:
    
    mktTxtOptr - The operator of the Marketing Text search criteria used in the search.
  - setNameOperator
```
public void setNameOperator(java.lang.String nameOptr)
```
    Sets the operator of the Collateral Name search criteria used in the search.
    
    Parameters:
    
    nameOptr - The operator of the Collateral Name search criteria used in the search.
  - setURLOperator
```
public void setURLOperator(java.lang.String URLOptr)
```
    Sets the operator of the Collateral URL search criteria used in the search.
    
    Parameters:
    
    URLOptr - The operator of the Collateral URL search criteria used in the search.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    Gets the value of the order by clause used in the search query.
    
    Returns:
    
    The value of the order by clause used in the search query.
  - setOrderBy
```
public void setOrderBy(java.lang.String string)
```
    Sets the value of the order by clause used in the search query.
    
    Parameters:
    
    string - The value of the order by clause used in the search query.
  - getURL
```
public java.lang.String getURL()
```
    Gets the value of the Collateral URL search criteria used in the search.
    
    Returns:
    
    The value of the Collateral URL search criteria used in the search.
  - setURL
```
public void setURL(java.lang.String ClkURL)
```
    Sets the value of the Collateral URL search criteria used in the search.
    
    Parameters:
    
    ClkURL - The value of the Collateral URL search criteria used in the search.
  - getMaxResult
```
public java.lang.String getMaxResult()
```
    Gets the maximum number of results to be returned in the search.
    
    Returns:
    
    The maximum number of results to be returned in the search.
  - setMaxResult
```
public void setMaxResult(java.lang.String maxRes)
```
    Sets the maximum number of results to be returned in the search.
    
    Parameters:
    
    maxRes - The maximum number of results to be returned in the search.
  - getCommandInterfaceName
```
public java.lang.String getCommandInterfaceName()
```
    Gets the command interface name.
    
    Specified by:
    
    getCommandInterfaceName in interface CommandDataBean
    
    Returns:
    
    The name of the command interface.
  - setCommandInterfaceName
```
public void setCommandInterfaceName(java.lang.String ifname)
```
    Sets the command interface name.
    
    Specified by:
    
    setCommandInterfaceName in interface CommandDataBean
    
    Parameters:
    
    ifname - The name of the interface of the command.
  - getRequestProperties
```
public TypedProperty getRequestProperties()
```
    Returns the request properties of the databean.
    
    Specified by:
    
    getRequestProperties in interface InputDataBean
    
    Returns:
    
    The request properties.
  - setRequestProperties
```
public void setRequestProperties(TypedProperty param)
                          throws java.lang.Exception
```
    Set the requestProperties associated with the data bean. If the requestProperties is null when the activate method on the DataBeanManager is invoked, the DataBeanManager sets the request properties based on the request properties set in the request.
    
    Specified by:
    
    setRequestProperties in interface InputDataBean
    
    Parameters:
    
    requestProperties - The set of properties passed to the JSP page that invokes this data bean,
    
    Throws:
    
    java.lang.Exception - If there is a problem when setting the request properties. This particular method should not throw any exception because it just stores the request properties.
  - getCpgnCollDataBeans
```
public CampaignCollateralDataBean[] getCpgnCollDataBeans()
```
    Gets all the collateral data beans that matches this search.
    
    Returns:
    
    An array of CampaignCollateralDataBean.
  - getIniPos
```
public java.lang.String getIniPos()
```
    Gets the start position for result set cursor.
    
    Returns:
    
    The start position for result set cursor.
  - setCpgnCollDataBeans
```
public void setCpgnCollDataBeans(CampaignCollateralDataBean[] beans)
```
    Sets the array of collateral beans that is returned by this search command.
    
    Parameters:
    
    beans - The array of collateral beans that is returned by this search command.
  - setIniPos
```
public void setIniPos(java.lang.String iniPosition)
```
    Sets the start position for result set cursor.
    
    Parameters:
    
    iniPosition - The start position for result set cursor.

Class CollateralSearchListDataBean

Field Summary

Fields inherited from interface com.ibm.commerce.beans.DataBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

Constructor Detail

CollateralSearchListDataBean

Method Detail

getFileName

getMktTxt

getName

setFileName

setMktTxt

setName

getFileNameOperator

getMktTxtOperator

getNameOperator

getURLOperator

setFileNameOperator

setMktTxtOperator

setNameOperator

setURLOperator

getOrderBy

setOrderBy

getURL

setURL

getMaxResult

setMaxResult

getCommandInterfaceName

setCommandInterfaceName

getRequestProperties

setRequestProperties

getCpgnCollDataBeans

getIniPos

setCpgnCollDataBeans

setIniPos