CustomerTagIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

CustomerTag
```
public interface CustomerTagIf
```
A customer tag is used to save customer related information used mainly for marketing purposes.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCustom1()`
`java.lang.String`	`getCustom2()`
`java.lang.String`	`getCustom3()`
`java.lang.String`	`getCustom4()`
`java.lang.String`	`getCustom5()`
`int`	`getCustomerId()`
`java.util.Calendar`	`getDateAdded()` The last time the value of the tag (for a customer) was modified
`java.lang.String`	`getDescription()` Description used in expression builder.
`int`	`getId()`
`int`	`getMaxInts()` When the tag value is of type `MULTI_INT_TYPE` or `MULTI_INT_PLUS_TIME_TYPE`, this attribute specifies the maximum number of integers allowed.
`java.lang.String`	`getName()` The tag name, normally in caps.
`int`	`getType()` The type of tag.
`java.lang.String`	`getValidation()` A regular expression validation string used when a new tag is inserted.
`java.lang.String`	`getValue()` The value of the tag for a customer.
`int`	`getWeighting()`
`boolean`	`isSetByApi()` When true the tag value can be set using the application (KKengIf) APIs
`boolean`	`isUsedInExpressions()` When true, the tag is added to the drop list of available tags in the Admin App expression builder
`boolean`	`isValueExists()`
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom2(java.lang.String custom2)`
`void`	`setCustom3(java.lang.String custom3)`
`void`	`setCustom4(java.lang.String custom4)`
`void`	`setCustom5(java.lang.String custom5)`
`void`	`setCustomerId(int customerId)`
`void`	`setDateAdded(java.util.Calendar dateAdded)` The last time the value of the tag (for a customer) was modified
`void`	`setDescription(java.lang.String description)` Description used in expression builder.
`void`	`setId(int id)`
`void`	`setMaxInts(int maxInts)` When the tag value is of type `MULTI_INT_TYPE` or `MULTI_INT_PLUS_TIME_TYPE`, this attribute specifies the maximum number of integers allowed.
`void`	`setName(java.lang.String name)` The tag name, normally in caps.
`void`	`setSetByApi(boolean setByApi)` When true the tag value can be set using the application (KKengIf) APIs
`void`	`setType(int type)` The type of tag.
`void`	`setUsedInExpressions(boolean usedInExpressions)` When true, the tag is added to the drop list of available tags in the Admin App expression builder
`void`	`setValidation(java.lang.String validation)` A regular expression validation string used when a new tag is inserted.
`void`	`setValue(java.lang.String value)` The value of the tag for a customer.
`void`	`setValueExists(boolean valueExists)`
`void`	`setWeighting(int weighting)`

- Method Detail
  - getId
```
int getId()
```
    Returns:
    
    the id
  - setId
```
void setId(int id)
```
    Parameters:
    
    id - the id to set
  - getName
```
java.lang.String getName()
```
    The tag name, normally in caps. i.e. AGE, PRODUCTS_VIEWED, SEARCH_STRING
    
    Returns:
    
    the name
  - setName
```
void setName(java.lang.String name)
```
    The tag name, normally in caps. i.e. AGE, PRODUCTS_VIEWED, SEARCH_STRING
    
    Parameters:
    
    name - the name to set
  - getDescription
```
java.lang.String getDescription()
```
    Description used in expression builder. i.e. Age of customer, Product recently viewed etc.
    
    Returns:
    
    the description
  - setDescription
```
void setDescription(java.lang.String description)
```
    Description used in expression builder. i.e. Age of customer, Product recently viewed etc.
    
    Parameters:
    
    description - the description to set
  - getValue
```
java.lang.String getValue()
```
    The value of the tag for a customer.
    
    Returns:
    
    the value
  - setValue
```
void setValue(java.lang.String value)
```
    The value of the tag for a customer.
    
    Parameters:
    
    value - the value to set
  - getValidation
```
java.lang.String getValidation()
```
    A regular expression validation string used when a new tag is inserted.
    
    Returns:
    
    the validation
  - setValidation
```
void setValidation(java.lang.String validation)
```
    A regular expression validation string used when a new tag is inserted.
    
    Parameters:
    
    validation - the validation to set
  - getType
```
int getType()
```
    The type of tag. Valid values are:
    - STRING_TYPE=0: The tag value is a String
    - INT_TYPE=1: The tag value is an integer
    - MULTI_INT_TYPE=2: The tag value contains one or more integers separated by a delimiter. The maxInts attributes determines how many integers are allowed.
    - DECIMAL_TYPE=3: The tag value is a decimal.
    - DATE_TYPE=4: The tag value is a date.
    - BOOLEAN_TYPE=5: The tag value is a boolean and so must contain the string true or false
    - AGE_TYPE=6: The tag value is a date. When creating expressions you can define the value to be greater or less than a length of time (in seconds) rather than comparing it to a specific date.
    - MULTI_INT_PLUS_TIME_TYPE=7: The tag value contains one or more integer and timestamp pairs separated by a delimiter. The maxInts attributes determines how many integers are allowed. The integer and timestamp are separated by a space character. The timestamp is the number of milliseconds since 1st January 1970 (Epoch time)
    Returns:
    
    the type
  - setType
```
void setType(int type)
```
    The type of tag. Valid values are:
    - STRING_TYPE=0: The tag value is a String
    - INT_TYPE=1: The tag value is an integer
    - MULTI_INT_TYPE=2: The tag value contains one or more integers separated by a delimiter. The maxInts attributes determines how many integers are allowed.
    - DECIMAL_TYPE=3: The tag value is a decimal.
    - DATE_TYPE=4: The tag value is a date.
    - BOOLEAN_TYPE=5: The tag value is a boolean and so must contain the string true or false
    - AGE_TYPE=6: The tag value is a date. When creating expressions you can define the value to be greater or less than a length of time (in seconds) rather than comparing it to a specific date.
    - MULTI_INT_PLUS_TIME_TYPE=7: The tag value contains one or more integer and timestamp pairs separated by a delimiter. The maxInts attributes determines how many integers are allowed. The integer and timestamp are separated by a space character. The timestamp is the number of milliseconds since 1st January 1970 (Epoch time)
    Parameters:
    
    type - the type to set
  - getMaxInts
```
int getMaxInts()
```
    When the tag value is of type MULTI_INT_TYPE or MULTI_INT_PLUS_TIME_TYPE, this attribute specifies the maximum number of integers allowed.
    
    Returns:
    
    the maxInts
  - setMaxInts
```
void setMaxInts(int maxInts)
```
    When the tag value is of type MULTI_INT_TYPE or MULTI_INT_PLUS_TIME_TYPE, this attribute specifies the maximum number of integers allowed.
    
    Parameters:
    
    maxInts - the maxInts to set
  - getDateAdded
```
java.util.Calendar getDateAdded()
```
    The last time the value of the tag (for a customer) was modified
    
    Returns:
    
    the dateAdded
  - setDateAdded
```
void setDateAdded(java.util.Calendar dateAdded)
```
    The last time the value of the tag (for a customer) was modified
    
    Parameters:
    
    dateAdded - the dateAdded to set
  - getCustom1
```
java.lang.String getCustom1()
```
    Returns:
    
    the custom1
  - setCustom1
```
void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
java.lang.String getCustom2()
```
    Returns:
    
    the custom2
  - setCustom2
```
void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom3
```
java.lang.String getCustom3()
```
    Returns:
    
    the custom3
  - setCustom3
```
void setCustom3(java.lang.String custom3)
```
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom4
```
java.lang.String getCustom4()
```
    Returns:
    
    the custom4
  - setCustom4
```
void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - the custom4 to set
  - getCustom5
```
java.lang.String getCustom5()
```
    Returns:
    
    the custom5
  - setCustom5
```
void setCustom5(java.lang.String custom5)
```
    Parameters:
    
    custom5 - the custom5 to set
  - isSetByApi
```
boolean isSetByApi()
```
    When true the tag value can be set using the application (KKengIf) APIs
    
    Returns:
    
    the setByApi
  - setSetByApi
```
void setSetByApi(boolean setByApi)
```
    When true the tag value can be set using the application (KKengIf) APIs
    
    Parameters:
    
    setByApi - the setByApi to set
  - getCustomerId
```
int getCustomerId()
```
    Returns:
    
    the customerId
  - setCustomerId
```
void setCustomerId(int customerId)
```
    Parameters:
    
    customerId - the customerId to set
  - isValueExists
```
boolean isValueExists()
```
    Returns:
    
    the valueExists
  - setValueExists
```
void setValueExists(boolean valueExists)
```
    Parameters:
    
    valueExists - the valueExists to set
  - getWeighting
```
int getWeighting()
```
    Returns:
    
    the weighting
  - setWeighting
```
void setWeighting(int weighting)
```
    Parameters:
    
    weighting - the weighting to set
  - isUsedInExpressions
```
boolean isUsedInExpressions()
```
    When true, the tag is added to the drop list of available tags in the Admin App expression builder
    
    Returns:
    
    the usedInExpressions
  - setUsedInExpressions
```
void setUsedInExpressions(boolean usedInExpressions)
```
    When true, the tag is added to the drop list of available tags in the Admin App expression builder
    
    Parameters:
    
    usedInExpressions - the usedInExpressions to set

Interface CustomerTagIf

Method Summary

Method Detail

getId

setId

getName

setName

getDescription

setDescription

getValue

setValue

getValidation

setValidation

getType

setType

getMaxInts

setMaxInts

getDateAdded

setDateAdded

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

isSetByApi

setSetByApi

getCustomerId

setCustomerId

isValueExists

setValueExists

getWeighting

setWeighting

isUsedInExpressions

setUsedInExpressions