CollateralSearchCmdImpl

java.lang.Object
- com.ibm.websphere.command.TargetableCommandImpl
- - com.ibm.websphere.command.CacheableCommandImpl
  - - com.ibm.commerce.command.MeasuredCacheableCommandImpl
    - - com.ibm.commerce.command.AbstractECTargetableCommand
      - com.ibm.commerce.command.DataBeanCommandImpl
        
        com.ibm.commerce.tools.campaigns.search.commands.CollateralSearchCmdImpl

All Implemented Interfaces:

DataBeanCommand, ECCommand, ECTargetableCommand, com.ibm.commerce.command.TargetableECCommand, CollateralSearchListBeanConsts, CollateralSearchUtilityConstants, CollateralSearchCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
```
public class CollateralSearchCmdImpl
extends DataBeanCommandImpl
implements CollateralSearchListBeanConsts, CollateralSearchUtilityConstants, CollateralSearchCmd
```
This Command searches the database to return a set of Collateral that satisfies search criteria.

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 class com.ibm.commerce.command.DataBeanCommandImpl
  emptyString, EURO_CODE
- Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl
  LOCAL
- Fields inherited from interface com.ibm.commerce.tools.campaigns.search.beans.CollateralSearchListBeanConsts
  OPERATOR_EQUAL, OPERATOR_LIKE, ORDER_ADDTXT, ORDER_CLICKACT, ORDER_COLLDESCFIELD1, ORDER_COLLDESCFIELD2, ORDER_COLLFIELD1, ORDER_COLLFIELD2, ORDER_FILENAME, ORDER_NAME
- Fields inherited from interface com.ibm.commerce.tools.campaigns.search.CollateralSearchUtilityConstants
  AND_OPERATOR, ASC_OPERATOR, ATCHAST_ATCHASTPATH_ATTR, ATCHAST_ATCHTGTID_ATTR, ATCHOBJTYP_ATCHOBJTYPID_ATTR, ATCHOBJTYP_IDENTIFIER_ATTR, ATCHREL_ATCHOBJTYPID_ATTR, ATCHREL_ATCHTGTID_ATTR, ATCHREL_OBJECTID_ATTR, COLLATERAL_COLLATERALID_ATTR, COLLATERAL_FIELD1_ATTR, COLLATERAL_FIELD2_ATTR, COLLATERAL_NAME_ATTR, COLLATERAL_STORE_ATTR, COLLATERAL_TYPEID_ATTR, COLLATERAL_URL_ATTR, COLLDESC_COLLATERALID_ATTR, COLLDESC_FIELD1_ATTR, COLLDESC_FIELD2_ATTR, COLLDESC_FILENAME_ATTR, COLLDESC_LANGUAGEID_ATTR, COLLDESC_MKTTXT_ATTR, DESC_OPERATOR, EQ_OPERATOR, GROUP_BY_OPERATOR, IN_OPERATOR, LIKE_OPERATOR, ORDER_BY_OPERATOR, UPPER_FUNCTION
- Fields inherited from interface com.ibm.commerce.tools.campaigns.search.commands.CollateralSearchCmd
  defaultCommandClassName, NAME
- Fields inherited from interface com.ibm.commerce.command.TargetableECCommand
  defaultCommandClassName
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

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

Constructor Summary

Constructors
Constructor and Description

CollateralSearchCmdImpl()

Constructors
Constructor and Description
`CollateralSearchCmdImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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.
`boolean`	`isReadyToCallExecute()` Checks to see if the command is ready to call.
`void`	`performExecute()` This method performs the execution of this command, where the search query is being constructed and executed, and the result set is used to generate the result of the search in the form of collateral data beans.
`void`	`populateDataBeanCommand(InputDataBean aCollateralSearchListDataBean)` This method populates the value of all search criterion to this search command from the input data bean.
`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`	`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 com.ibm.commerce.command.DataBeanCommandImpl
getDataBean, setDataBean, setRequestProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl
getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

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

Methods inherited from interface com.ibm.commerce.command.TargetableECCommand
execute

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from interface com.ibm.websphere.command.Command
reset

Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CollateralSearchCmdImpl
```
public CollateralSearchCmdImpl()
```
- Method Detail
  - getCpgnCollDataBeans
```
public CampaignCollateralDataBean[] getCpgnCollDataBeans()
```
    Gets all the collateral data beans that matches this search.
    
    Returns:
    
    An array of CampaignCollateralDataBean.
  - 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.
  - 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.
  - getIniPos
```
public java.lang.String getIniPos()
```
    Gets the start position for result set cursor.
    
    Returns:
    
    Initial position for result set.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - performExecute
```
public void performExecute()
                    throws ECException
```
    This method performs the execution of this command, where the search query is being constructed and executed, and the result set is used to generate the result of the search in the form of collateral data beans.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException.
    
    ECException
  - populateDataBeanCommand
```
public void populateDataBeanCommand(InputDataBean aCollateralSearchListDataBean)
```
    This method populates the value of all search criterion to this search command from the input data bean.
    
    Overrides:
    
    populateDataBeanCommand in class DataBeanCommandImpl
    
    Parameters:
    
    aCollateralSearchListDataBean - The data bean object used to populate all the fields in this command.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - isReadyToCallExecute
```
public boolean isReadyToCallExecute()
```
    Checks to see if the command is ready to call.
    
    Specified by:
    
    isReadyToCallExecute in interface com.ibm.websphere.command.Command
    
    Overrides:
    
    isReadyToCallExecute in class AbstractECTargetableCommand
    
    Returns:
    
    Always returns 'true'.

Fields inherited from class com.ibm.commerce.command.DataBeanCommandImpl

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

Fields inherited from interface com.ibm.commerce.tools.campaigns.search.beans.CollateralSearchListBeanConsts

Fields inherited from interface com.ibm.commerce.tools.campaigns.search.CollateralSearchUtilityConstants

Fields inherited from interface com.ibm.commerce.tools.campaigns.search.commands.CollateralSearchCmd

Fields inherited from interface com.ibm.commerce.command.TargetableECCommand

Fields inherited from interface com.ibm.websphere.command.Command

Methods inherited from class com.ibm.commerce.command.DataBeanCommandImpl

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.command.TargetableECCommand

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

Methods inherited from interface com.ibm.commerce.command.ECCommand

Methods inherited from interface com.ibm.websphere.command.Command

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

Methods inherited from interface com.ibm.websphere.command.CommandCaller

COPYRIGHT

CollateralSearchCmdImpl

getCpgnCollDataBeans

getFileName

getFileNameOperator

getIniPos

getMaxResult

getMktTxt

getMktTxtOperator

getName

getNameOperator

getOrderBy

getURL

getURLOperator

performExecute

populateDataBeanCommand

setCpgnCollDataBeans

setFileName

setFileNameOperator

setIniPos

setMaxResult

setMktTxt

setMktTxtOperator

setName

setNameOperator

setOrderBy

setURL

setURLOperator

isReadyToCallExecute