EMarketingSpotInvoker

java.lang.Object
- com.ibm.etools.xmlschema.beans.BaseType
- - com.ibm.etools.xmlschema.beans.ComplexType
  - - com.ibm.commerce.campaigns.cache.EMarketingSpotInvoker

All Implemented Interfaces:

java.io.Serializable
```
public class EMarketingSpotInvoker
extends com.ibm.etools.xmlschema.beans.ComplexType
```
This class represents the complex type

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

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

Constructor Summary

Constructors
Constructor and Description

EMarketingSpotInvoker()

Constructors
Constructor and Description
`EMarketingSpotInvoker()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCookieNames()` Gets the cookie names to be passed as part of the request.
`java.lang.String`	`getEMarketingSpotName()` Gets the name of the eMarketingSpot this entry invokes.
`boolean`	`getExclude()` Gets whether this entry to be considered an excluded invoker.
`int`	`getMaxAssociateCatalogEntries()` Gets the maximum number of associate catalog entries the eMarketingSpot should return.
`int`	`getMaxCatalogEntries()` Gets the maximum number of catalog entries the eMarketingSpot should return.
`int`	`getMaxCategories()` Gets the maximum number of categories the eMarketingSpot should return.
`int`	`getMaxCollateral()` Gets the maximum number of collateral the eMarketingSpot should return.
`java.lang.String`	`getName()` Gets the name of the eMarketingSpot invoker.
`java.lang.String`	`getParameterName()` Gets the name of a parameter to check on the query string.
`java.lang.String`	`getParameterValue()` Gets the value of a parameter to check on the query string.
`java.lang.String`	`getType()` Gets the type of the eMarketingSpot invoker.
`boolean`	`removeCookieNames()` Removes the cookie names to be passed as part of the request.
`boolean`	`removeEMarketingSpotName()` Removes the name of the eMarketingSpot this entry invokes.
`boolean`	`removeExclude()` Removes the flag indicating whether this entry to be considered an excluded invoker.
`boolean`	`removeMaxAssociateCatalogEntries()` Removes the maximum number of associate catalog entries the eMarketingSpot should return.
`boolean`	`removeMaxCatalogEntries()` Removes the maximum number of catalog entries the eMarketingSpot should return.
`boolean`	`removeMaxCategories()` Removes the maximum number of categories the eMarketingSpot should return.
`boolean`	`removeMaxCollateral()` Removes the maximum number of collateral the eMarketingSpot should return.
`boolean`	`removeName()` Removes the name of the eMarketingSpot invoker.
`boolean`	`removeParameterName()` Removes the name of a parameter to check on the query string.
`boolean`	`removeParameterValue()` Removes the value of a parameter to check on the query string.
`boolean`	`removeType()` Removes the type of the eMarketingSpot invoker.
`void`	`setCookieNames(java.lang.String names)` Sets the cookie names to be passed as part of the request.
`void`	`setEMarketingSpotName(java.lang.String eMarketingSpotName)` Sets the name of the eMarketingSpot this entry invokes.
`void`	`setExclude(boolean exclude)` Sets this entry to be considered an excluded invoker.
`void`	`setMaxAssociateCatalogEntries(int maxAssociateCatalogEntries)` Sets the maximum number of associate catalog entries the eMarketingSpot should return.
`void`	`setMaxCatalogEntries(int maxCatalogEntries)` Sets the maximum number of catalog entries the eMarketingSpot should return.
`void`	`setMaxCategories(int maxCategories)` Sets the maximum number of categories the eMarketingSpot should return.
`void`	`setMaxCollateral(int maxCollateral)` Sets the maximum number of collateral the eMarketingSpot should return.
`void`	`setName(java.lang.String name)` Sets the name of the eMarketingSpot invoker.
`void`	`setParameterName(java.lang.String name)` Sets the name of a parameter to check on the query string.
`void`	`setParameterValue(java.lang.String value)` Sets the value of a parameter to check on the query string.
`void`	`setType(java.lang.String type)` Sets the type of the eMarketingSpot invoker.

Methods inherited from class com.ibm.etools.xmlschema.beans.ComplexType
getAttributeBooleanValue, getAttributeByteValue, getAttributeDateValue, getAttributeDoubleValue, getAttributeFloatValue, getAttributeIntegerValue, getAttributeLongValue, getAttributeShortValue, getAttributeValue, getAttributeValue, getElementBooleanValue, getElementByteValue, getElementDateValue, getElementDoubleValue, getElementFloatValue, getElementIntegerValue, getElementLongValue, getElementShortValue, removeAttribute, removeElement, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue

Methods inherited from class com.ibm.etools.xmlschema.beans.BaseType
getElementBooleanValue, getElementByteValue, getElementDateValue, getElementDoubleValue, getElementFloatValue, getElementIntegerValue, getElementLongValue, getElementName, getElementShortValue, getElementValue, getElementValue, getElementValue, getElementValue, getElementValue, getPrefix, getXMLAttribute, getXMLElement, isAttributeQualified, isElementQualified, removeElement, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, setElementValue, sizeOfElement, updateElementValue, updateElementValue, updateElementValue, updateElementValue, updateElementValue, updateElementValue, updateElementValue, updateElementValue, updateElementValue

Methods inherited from class java.lang.Object
equals, 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
  - EMarketingSpotInvoker
```
public EMarketingSpotInvoker()
```
- Method Detail
  - getCookieNames
```
public java.lang.String getCookieNames()
```
    Gets the cookie names to be passed as part of the request. This is optional.
    
    Returns:
    
    the comma-separated string containing the cookie names. A value of "*" means all cookies.
  - getEMarketingSpotName
```
public java.lang.String getEMarketingSpotName()
```
    Gets the name of the eMarketingSpot this entry invokes.
    
    Returns:
    
    the eMarketingSpot name.
  - getExclude
```
public boolean getExclude()
```
    Gets whether this entry to be considered an excluded invoker. Used when a eMarketingSpot is set to be invoked by all commands for a store.
    
    Returns:
    
    true if the invoker is to be excluded, false otherwise.
  - getMaxAssociateCatalogEntries
```
public int getMaxAssociateCatalogEntries()
```
    Gets the maximum number of associate catalog entries the eMarketingSpot should return.
    
    Returns:
    
    the maximum number of associate catalog entries the eMarketingSpot should return.
  - getMaxCatalogEntries
```
public int getMaxCatalogEntries()
```
    Gets the maximum number of catalog entries the eMarketingSpot should return.
    
    Returns:
    
    the maximum number of catalog entries the eMarketingSpot should return.
  - getMaxCategories
```
public int getMaxCategories()
```
    Gets the maximum number of categories the eMarketingSpot should return.
    
    Returns:
    
    the maximum number of categories the eMarketingSpot should return.
  - getMaxCollateral
```
public int getMaxCollateral()
```
    Gets the maximum number of collateral the eMarketingSpot should return.
    
    Returns:
    
    the maximum number of collateral the eMarketingSpot should return.
  - getName
```
public java.lang.String getName()
```
    Gets the name of the eMarketingSpot invoker.
    
    Returns:
    
    the name of the eMarketingSpot invoker.
  - getParameterName
```
public java.lang.String getParameterName()
```
    Gets the name of a parameter to check on the query string. This is optional.
    
    Returns:
    
    the name of a parameter to check on the query string.
  - getParameterValue
```
public java.lang.String getParameterValue()
```
    Gets the value of a parameter to check on the query string. This is optional.
    
    Returns:
    
    the value of a parameter to check on the query string.
  - getType
```
public java.lang.String getType()
```
    Gets the type of the eMarketingSpot invoker.
    
    Returns:
    
    the type of the eMarketingSpot invoker.
  - removeCookieNames
```
public boolean removeCookieNames()
```
    Removes the cookie names to be passed as part of the request.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeEMarketingSpotName
```
public boolean removeEMarketingSpotName()
```
    Removes the name of the eMarketingSpot this entry invokes.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeExclude
```
public boolean removeExclude()
```
    Removes the flag indicating whether this entry to be considered an excluded invoker. Used when a eMarketingSpot is set to be invoked by all commands for a store.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeMaxAssociateCatalogEntries
```
public boolean removeMaxAssociateCatalogEntries()
```
    Removes the maximum number of associate catalog entries the eMarketingSpot should return.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeMaxCatalogEntries
```
public boolean removeMaxCatalogEntries()
```
    Removes the maximum number of catalog entries the eMarketingSpot should return.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeMaxCategories
```
public boolean removeMaxCategories()
```
    Removes the maximum number of categories the eMarketingSpot should return.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeMaxCollateral
```
public boolean removeMaxCollateral()
```
    Removes the maximum number of collateral the eMarketingSpot should return.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeName
```
public boolean removeName()
```
    Removes the name of the eMarketingSpot invoker.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeParameterName
```
public boolean removeParameterName()
```
    Removes the name of a parameter to check on the query string.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeParameterValue
```
public boolean removeParameterValue()
```
    Removes the value of a parameter to check on the query string.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeType
```
public boolean removeType()
```
    Removes the type of the eMarketingSpot invoker.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - setCookieNames
```
public void setCookieNames(java.lang.String names)
```
    Sets the cookie names to be passed as part of the request. This is optional.
    
    Parameters:
    
    names - the comma-separated string containing the cookie names. A value of "*" means all cookies.
  - setEMarketingSpotName
```
public void setEMarketingSpotName(java.lang.String eMarketingSpotName)
```
    Sets the name of the eMarketingSpot this entry invokes.
    
    Parameters:
    
    eMarketingSpotName - the eMarketingSpot name.
  - setExclude
```
public void setExclude(boolean exclude)
```
    Sets this entry to be considered an excluded invoker. Used when a eMarketingSpot is set to be invoked by all commands for a store.
    
    Parameters:
    
    exclude - set to true if the invoker is to be excluded.
  - setMaxAssociateCatalogEntries
```
public void setMaxAssociateCatalogEntries(int maxAssociateCatalogEntries)
```
    Sets the maximum number of associate catalog entries the eMarketingSpot should return.
    
    Parameters:
    
    maxAssociateCatalogEntries - the maximum number of associate catalog entries the eMarketingSpot should return.
  - setMaxCatalogEntries
```
public void setMaxCatalogEntries(int maxCatalogEntries)
```
    Sets the maximum number of catalog entries the eMarketingSpot should return.
    
    Parameters:
    
    maxCatalogEntries - the maximum number of catalog entries the eMarketingSpot should return.
  - setMaxCategories
```
public void setMaxCategories(int maxCategories)
```
    Sets the maximum number of categories the eMarketingSpot should return.
    
    Parameters:
    
    maxCategories - the maximum number of categories the eMarketingSpot should return.
  - setMaxCollateral
```
public void setMaxCollateral(int maxCollateral)
```
    Sets the maximum number of collateral the eMarketingSpot should return.
    
    Parameters:
    
    maxCollateral - the maximum number of collateral the eMarketingSpot should return.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the eMarketingSpot invoker.
    
    Parameters:
    
    name - the name of the eMarketingSpot invoker.
  - setParameterName
```
public void setParameterName(java.lang.String name)
```
    Sets the name of a parameter to check on the query string. This is optional.
    
    Parameters:
    
    name - the name of a parameter to check on the query string.
  - setParameterValue
```
public void setParameterValue(java.lang.String value)
```
    Sets the value of a parameter to check on the query string. This is optional.
    
    Parameters:
    
    value - the value of a parameter to check on the query string.
  - setType
```
public void setType(java.lang.String type)
```
    Sets the type of the eMarketingSpot invoker.
    
    Parameters:
    
    type - the type of the eMarketingSpot invoker.

Methods inherited from class com.ibm.etools.xmlschema.beans.ComplexType

Methods inherited from class com.ibm.etools.xmlschema.beans.BaseType

Methods inherited from class java.lang.Object

COPYRIGHT

EMarketingSpotInvoker

getCookieNames

getEMarketingSpotName

getExclude

getMaxAssociateCatalogEntries

getMaxCatalogEntries

getMaxCategories

getMaxCollateral

getName

getParameterName

getParameterValue

getType

removeCookieNames

removeEMarketingSpotName

removeExclude

removeMaxAssociateCatalogEntries

removeMaxCatalogEntries

removeMaxCategories

removeMaxCollateral

removeName

removeParameterName

removeParameterValue

removeType

setCookieNames

setEMarketingSpotName

setExclude

setMaxAssociateCatalogEntries

setMaxCatalogEntries

setMaxCategories

setMaxCollateral

setName

setParameterName

setParameterValue

setType