AdminCustomerTag (KonaKartAdmin API Documentation)

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

```
public class AdminCustomerTag
extends java.lang.Object
```
A customer tag is used to save customer related information used mainly for marketing purposes.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AGE_TYPE` The string in the Value attribute is a Date.
`static int`	`BOOLEAN_TYPE` The string in the Value attribute is a boolean (should contain the string `true` or `false`)
`private java.lang.String`	`custom1` Custom fields
`private java.lang.String`	`custom2`
`private java.lang.String`	`custom3`
`private java.lang.String`	`custom4`
`private java.lang.String`	`custom5`
`private int`	`customerId` customerId - Set to identify the customer when the value is set.
`static int`	`DATE_TYPE` The string in the Value attribute is a Date.
`private java.util.Date`	`dateAdded` dateAdded
`static int`	`DECIMAL_TYPE` The string in the Value attribute is a Decimal
`static java.lang.String`	`DELIM` Used as the delimiter when storing multiple integers
`private java.lang.String`	`description` Description used in expression builder.
`private int`	`id` id
`static int`	`INT_TYPE` The string in the Value attribute is an int
`private int`	`maxInts` When the tag value is of type `MULTI_INT_TYPE`, this attribute specifies the maximum number of integers allowed.
`static int`	`MULTI_INT_PLUS_TIME_TYPE` The string in the Value attribute consists of multiple integer plus timestamp pairs separated by a delimiter.
`static int`	`MULTI_INT_TYPE` The string in the Value attribute consists of multiple integers separated by a delimiter.
`private java.lang.String`	`name` The tag name, normally in caps.
`(package private) boolean`	`setByApi` Set by API
`static int`	`STRING_TYPE` The string in the Value attribute is a String
`private int`	`type` The type of tag.
`private boolean`	`usedInExpressions` Used in Expressions
`private java.lang.String`	`validation` A regular expression validation string used when a new tag is inserted.
`private java.lang.String`	`value` The value of the tag for a customer.
`private int`	`weighting` This weighting is used for calculating Product Recommendation Suggestions when the external AI engine is not available (or if there is insufficient data to use it).

Constructor Summary

Constructors
Constructor and Description
`AdminCustomerTag()` Constructor
`AdminCustomerTag(com.workingdogs.village.Record vr, com.konakart.db.KKCriteria c)` Instantiates the attributes of the CustomerTag object from a Record object

Method Summary

All Methods Instance Methods Concrete 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.lang.String`	`getCustTagTypeName()`
`java.util.Date`	`getDateAdded()`
`java.lang.String`	`getDescription()`
`int`	`getId()`
`int`	`getMaxInts()`
`java.lang.String`	`getName()`
`int`	`getType()`
`java.lang.String`	`getValidation()`
`java.lang.String`	`getValue()`
`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
`java.math.BigDecimal`	`kkGetValueAsBigDecimal()` Utility method to return a BigDecimal.
`boolean`	`kkGetValueAsBoolean()` Utility method to return a boolean.
`java.util.Date`	`kkGetValueAsDate()` Utility method to return a Date.
`int`	`kkGetValueAsInt()` Utility method to return an int.
`com.konakart.app.IntAndTimePair[]`	`kkGetValueAsIntAndTimeArray()` Utility method to return an array of integer and timestamp pairs.
`int[]`	`kkGetValueAsIntArray()` Utility method to return an array of integers.
`java.lang.String`	`kkGetValueAsString()` Utility method to return a String.
`java.lang.String[]`	`kkGetValueAsStringArray()` Utility method to return an array of Strings.
`void`	`kkSetValueAsBigDecimal(java.math.BigDecimal val)` Utility method to set the tag value as a BigDecimal.
`void`	`kkSetValueAsBoolean(boolean val)` Utility method to set the tag value as a boolean.
`void`	`kkSetValueAsDate(java.util.Date val)` Utility method to set the tag value as a Date.
`void`	`kkSetValueAsInt(int val)` Utility method to set the tag value as an int.
`void`	`kkSetValueAsIntAndTimeArray(com.konakart.app.IntAndTimePair[] value)` Utility method to set the tag value as an array of int and time pairs.
`void`	`kkSetValueAsIntArray(int[] val)` Utility method to set the tag value as an array of ints.
`void`	`kkSetValueAsString(java.lang.String val)` Utility method to set the tag value as a String.
`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.Date dateAdded)`
`void`	`setDescription(java.lang.String description)`
`void`	`setId(int id)`
`void`	`setMaxInts(int maxInts)`
`void`	`setName(java.lang.String name)`
`void`	`setSetByApi(boolean setByApi)` When true the tag value can be set using the application (KKengIf) APIs
`void`	`setType(int type)`
`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)`
`void`	`setValue(java.lang.String value)`
`void`	`setWeighting(int weighting)`
`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
  - DELIM
```
public static final java.lang.String DELIM
```
    Used as the delimiter when storing multiple integers
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE
```
public static final int STRING_TYPE
```
    The string in the Value attribute is a String
    
    See Also:
    
    Constant Field Values
  - INT_TYPE
```
public static final int INT_TYPE
```
    The string in the Value attribute is an int
    
    See Also:
    
    Constant Field Values
  - MULTI_INT_TYPE
```
public static final int MULTI_INT_TYPE
```
    The string in the Value attribute consists of multiple integers separated by a delimiter. The maxInts attributes determines how many integers are allowed.
    
    See Also:
    
    Constant Field Values
  - DECIMAL_TYPE
```
public static final int DECIMAL_TYPE
```
    The string in the Value attribute is a Decimal
    
    See Also:
    
    Constant Field Values
  - DATE_TYPE
```
public static final int DATE_TYPE
```
    The string in the Value attribute is a Date.
    
    See Also:
    
    Constant Field Values
  - BOOLEAN_TYPE
```
public static final int BOOLEAN_TYPE
```
    The string in the Value attribute is a boolean (should contain the string true or false)
    
    See Also:
    
    Constant Field Values
  - AGE_TYPE
```
public static final int AGE_TYPE
```
    The string in the Value attribute 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.
    
    See Also:
    
    Constant Field Values
  - MULTI_INT_PLUS_TIME_TYPE
```
public static final int MULTI_INT_PLUS_TIME_TYPE
```
    The string in the Value attribute consists of multiple integer plus timestamp pairs separated by a delimiter. The maxInts attributes determines how many integer/timestamp pairs 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).
    
    See Also:
    
    Constant Field Values
  - id
```
private int id
```
    id
  - customerId
```
private int customerId
```
    customerId - Set to identify the customer when the value is set. Negative if the value hasn't been set for a customer.
  - name
```
private java.lang.String name
```
    The tag name, normally in caps. i.e. AGE, PRODUCTS_VIEWED, SEARCH_STRING.
  - description
```
private java.lang.String description
```
    Description used in expression builder. i.e. Age of customer, Product recently viewed etc.
  - value
```
private java.lang.String value
```
    The value of the tag for a customer.
  - validation
```
private java.lang.String validation
```
    A regular expression validation string used when a new tag is inserted.
  - type
```
private int type
```
    The type of tag. Valid values are:
    - STRING_TYPE: The tag value is a String
    - INT_TYPE: The tag value is an integer
    - MULTI_INT_TYPE: The tag value contains one or more integers separated by a delimiter. The maxInts attributes determines how many integers are allowed.
    - MULTI_INT_PLUS_TIME_TYPE: 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 secs since 1st January 1970 (Epoch time)
    - DECIMAL_TYPE: The tag value is a decimal.
    - DATE_TYPE: The tag value is a date.
    - BOOLEAN_TYPE: The tag value is a boolean and so must contain the string true or false
    - AGE_TYPE: 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.
  - maxInts
```
private int maxInts
```
    When the tag value is of type MULTI_INT_TYPE, this attribute specifies the maximum number of integers allowed.
  - weighting
```
private int weighting
```
    This weighting is used for calculating Product Recommendation Suggestions when the external AI engine is not available (or if there is insufficient data to use it). A weighting (between 0 and 100) can be set for each customer tag to configure the scoring algorithm that KonaKart uses to determine which products to recommend.
  - dateAdded
```
private java.util.Date dateAdded
```
    dateAdded
  - custom1
```
private java.lang.String custom1
```
    Custom fields
  - custom2
```
private java.lang.String custom2
```
  - custom3
```
private java.lang.String custom3
```
  - custom4
```
private java.lang.String custom4
```
  - custom5
```
private java.lang.String custom5
```
  - setByApi
```
boolean setByApi
```
    Set by API
  - usedInExpressions
```
private boolean usedInExpressions
```
    Used in Expressions
- Constructor Detail
  - AdminCustomerTag
```
public AdminCustomerTag()
```
    Constructor
  - AdminCustomerTag
```
public AdminCustomerTag(com.workingdogs.village.Record vr,
                        com.konakart.db.KKCriteria c)
                 throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the CustomerTag object from a Record object
    
    Parameters:
    
    vr - 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 the CustomerTag object.
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing the attributes of the CustomerTag object.
  - kkGetValueAsInt
```
public int kkGetValueAsInt()
                    throws KKAdminException
```
    Utility method to return an int. An exception is thrown if the value is null or can't be parsed as an int.
    
    Returns:
    
    Returns an int
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - kkGetValueAsIntArray
```
public int[] kkGetValueAsIntArray()
```
    Utility method to return an array of integers. An array of integers is stored in a String format with each integer separated by a delimiter. This method parses the String and returns an array of integers. It works for both MULTI_INT_TYPE or MULTI_INT_PLUS_TIME_TYPE tag types.
    
    Returns:
    
    Returns an array of integers.
  - kkGetValueAsIntAndTimeArray
```
public com.konakart.app.IntAndTimePair[] kkGetValueAsIntAndTimeArray()
                                                              throws KKAdminException
```
    Utility method to return an array of integer and timestamp pairs. An array of integer and timestamp pairs is stored in a String format with each integer and timestamp pair separated by a delimiter. This method parses the String and returns an array of integer and timestamp pairs.
    
    Returns:
    
    Returns an array of integer and timestamp pairs.
    
    Throws:
    
    KKAdminException - if the format is illegal
  - kkGetValueAsStringArray
```
public java.lang.String[] kkGetValueAsStringArray()
```
    Utility method to return an array of Strings. An array of Strings is stored in a String format with each String separated by a delimiter. This method parses the String and returns an array of Strings. It works for STRING_TYPE tag types.
    
    Returns:
    
    Returns an array of integers.
  - kkGetValueAsDate
```
public java.util.Date kkGetValueAsDate()
                                throws KKAdminException,
                                       java.text.ParseException
```
    Utility method to return a Date. Null is returned if the value is null. An exception is thrown if the value isn't null but can't be parsed as a Date.
    
    Returns:
    
    Returns a date
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
    
    java.text.ParseException - an unexpected ParseException exception
  - kkGetValueAsString
```
public java.lang.String kkGetValueAsString()
```
    Utility method to return a String. The value is returned directly with no processing.
    
    Returns:
    
    Returns a String
  - kkGetValueAsBigDecimal
```
public java.math.BigDecimal kkGetValueAsBigDecimal()
```
    Utility method to return a BigDecimal. Null is returned if the value is null. An exception is thrown if the value isn't null but can't be parsed as a BigDecimal.
    
    Returns:
    
    Returns a BigDecimal
  - kkGetValueAsBoolean
```
public boolean kkGetValueAsBoolean()
                            throws KKAdminException
```
    Utility method to return a boolean. An exception is thrown if the value is null or isn't set to "true" or "false".
    
    Returns:
    
    Returns a boolean
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - kkSetValueAsInt
```
public void kkSetValueAsInt(int val)
```
    Utility method to set the tag value as an int.
    
    Parameters:
    
    val - the val
  - kkSetValueAsIntArray
```
public void kkSetValueAsIntArray(int[] val)
```
    Utility method to set the tag value as an array of ints.
    
    Parameters:
    
    val - the value
  - kkSetValueAsIntAndTimeArray
```
public void kkSetValueAsIntAndTimeArray(com.konakart.app.IntAndTimePair[] value)
```
    Utility method to set the tag value as an array of int and time pairs.
    
    Parameters:
    
    value - the value
  - kkSetValueAsDate
```
public void kkSetValueAsDate(java.util.Date val)
```
    Utility method to set the tag value as a Date.
    
    Parameters:
    
    val - the val
  - kkSetValueAsBoolean
```
public void kkSetValueAsBoolean(boolean val)
```
    Utility method to set the tag value as a boolean.
    
    Parameters:
    
    val - the val
  - kkSetValueAsString
```
public void kkSetValueAsString(java.lang.String val)
```
    Utility method to set the tag value as a String.
    
    Parameters:
    
    val - the val
  - kkSetValueAsBigDecimal
```
public void kkSetValueAsBigDecimal(java.math.BigDecimal val)
```
    Utility method to set the tag value as a BigDecimal.
    
    Parameters:
    
    val - the val
  - getId
```
public int getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - the id to set
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    the name
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    
    name - the name to set
  - getDescription
```
public java.lang.String getDescription()
```
    Returns:
    
    the description
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Parameters:
    
    description - the description to set
  - getValidation
```
public java.lang.String getValidation()
```
    Returns:
    
    the validation
  - setValidation
```
public void setValidation(java.lang.String validation)
```
    Parameters:
    
    validation - the validation to set
  - getType
```
public int getType()
```
    Returns:
    
    the type
  - setType
```
public void setType(int type)
```
    Parameters:
    
    type - the type to set
  - getMaxInts
```
public int getMaxInts()
```
    Returns:
    
    the maxInts
  - setMaxInts
```
public void setMaxInts(int maxInts)
```
    Parameters:
    
    maxInts - the maxInts to set. If the type is INT_TYPE maxInts must be at least 1.
  - 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
  - getCustom5
```
public java.lang.String getCustom5()
```
    Returns:
    
    the custom5
  - setCustom5
```
public void setCustom5(java.lang.String custom5)
```
    Parameters:
    
    custom5 - the custom5 to set
  - getDateAdded
```
public java.util.Date getDateAdded()
```
    Returns:
    
    the dateAdded
  - setDateAdded
```
public void setDateAdded(java.util.Date dateAdded)
```
    Parameters:
    
    dateAdded - the dateAdded to set
  - getValue
```
public java.lang.String getValue()
```
    Returns:
    
    the value
  - setValue
```
public void setValue(java.lang.String value)
```
    Parameters:
    
    value - the value to set
  - getCustomerId
```
public int getCustomerId()
```
    Returns:
    
    the customerId
  - setCustomerId
```
public void setCustomerId(int customerId)
```
    Parameters:
    
    customerId - the customerId to set
  - isSetByApi
```
public boolean isSetByApi()
```
    When true the tag value can be set using the application (KKengIf) APIs
    
    Returns:
    
    the setByApi
  - setSetByApi
```
public void setSetByApi(boolean setByApi)
```
    When true the tag value can be set using the application (KKengIf) APIs
    
    Parameters:
    
    setByApi - the setByApi to set
  - getCustTagTypeName
```
public java.lang.String getCustTagTypeName()
```
    Returns:
    
    returns a textual description of the type for diagnostic purposes only
  - getWeighting
```
public int getWeighting()
```
    Returns:
    
    the weighting
  - setWeighting
```
public void setWeighting(int weighting)
```
    Parameters:
    
    weighting - the weighting to set
  - isUsedInExpressions
```
public 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
```
public 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

Class AdminCustomerTag

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DELIM

STRING_TYPE

INT_TYPE

MULTI_INT_TYPE

DECIMAL_TYPE

DATE_TYPE

BOOLEAN_TYPE

AGE_TYPE

MULTI_INT_PLUS_TIME_TYPE

id

customerId

name

description

value

validation

type

maxInts

weighting

dateAdded

custom1

custom2

custom3

custom4

custom5

setByApi

usedInExpressions

Constructor Detail

AdminCustomerTag

AdminCustomerTag

Method Detail

toString

toStringBrief

kkGetValueAsInt

kkGetValueAsIntArray

kkGetValueAsIntAndTimeArray

kkGetValueAsStringArray

kkGetValueAsDate

kkGetValueAsString

kkGetValueAsBigDecimal

kkGetValueAsBoolean

kkSetValueAsInt

kkSetValueAsIntArray

kkSetValueAsIntAndTimeArray

kkSetValueAsDate

kkSetValueAsBoolean

kkSetValueAsString

kkSetValueAsBigDecimal

getId

setId

getName

setName

getDescription

setDescription

getValidation

setValidation

getType

setType

getMaxInts

setMaxInts

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

getDateAdded

setDateAdded

getValue

setValue

getCustomerId