com.konakart.blif

Interface CustomerTagMgrIf

All Known Implementing Classes:

CustomerTagMgr, CustomerTagMgrEE

public interface CustomerTagMgrIf

CustomerTagMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
void	addToCustomerTag(int customerId, java.lang.String tagName, int tagValue) This method is used for customer tags where the value is of type com.konakart.app.CustomerTag.MULTI_INT_TYPE or MULTI_INT_PLUS_TIME_TYPE.
void	addToCustomerTag(java.lang.String sessionId, java.lang.String tagName, int tagValue) This method is used for customer tags where the value is of type com.konakart.app.CustomerTag.MULTI_INT_TYPE or MULTI_INT_PLUS_TIME_TYPE.
void	addToCustomerTagForGuest(int customerId, java.lang.String tagName, int tagValue) This method is used for customer tags where the value is of type com.konakart.app.CustomerTag.MULTI_INT_TYPE or MULTI_INT_PLUS_TIME_TYPE.
void	deleteCustomerTag(java.lang.String sessionId, java.lang.String tagName) This method deletes the customer tag referenced by the parameter tagName and for the customer referenced by the sessionId.
void	deleteCustomerTagForGuest(int customerId, java.lang.String tagName) This method deletes the customer tag referenced by the parameter tagName and for the guest customer referenced by the negative customerId.
boolean	evaluateExpression(int customerId, int expressionId, java.lang.String expressionName) An expression object is retrieved from the database and evaluated for the customer referenced by the customerId.
boolean	evaluateExpression(java.lang.String sessionId, int expressionId, java.lang.String expressionName) An expression object is retrieved from the database and evaluated for the customer referenced by the sessionId.
boolean	evaluateExpressionForGuest(int customerId, int expressionId, java.lang.String expressionName) An expression object is retrieved from the database and evaluated for the guest customer referenced by the negative customerId.
CustomerTag	getCustomerTag(int customerId, java.lang.String tagName, boolean getValue) A CustomerTag object referenced by the parameter tagName is returned.
CustomerTagIf	getCustomerTag(java.lang.String sessionId, java.lang.String tagName) A CustomerTag object referenced by the parameter tagName is returned.
CustomerTagIf	getCustomerTagForGuest(int customerId, java.lang.String tagName) A CustomerTag object referenced by the parameter tagName is returned.
CustomerTagIf[]	getCustomerTags(int customerId) This method fetches all of the customer tags for the customer referenced by the customerId. An empty array is returned if no tags exist.
CustomerTagIf[]	getCustomerTags(java.lang.String sessionId) This method fetches all of the customer tags for the customer referenced by the sessionId. An empty array is returned if no tags exist.
CustomerTagIf[]	getCustomerTagsForGuest(int customerId) This method fetches all of the customer tags for the guest customer referenced by the customerId which must have a negative value.
java.lang.String	getCustomerTagValue(int customerId, java.lang.String tagName) A string is returned containing the value of the customer tag referenced by the parameter tagName and for the customer referenced by the customerId.
java.lang.String	getCustomerTagValue(java.lang.String sessionId, java.lang.String tagName) A string is returned containing the value of the customer tag referenced by the parameter tagName and for the customer referenced by the sessionId.
java.lang.String	getCustomerTagValueForGuest(int customerId, java.lang.String tagName) A string is returned containing the value of the customer tag referenced by the parameter tagName and for the guest customer referenced by the negative customerId.
ExpressionIf	getExpression(int custId, int expressionId, java.lang.String expressionName) An Expression object, fully populated with an array of Expression Variables is returned.
ExpressionIf	getExpression(java.lang.String sessionId, int expressionId, java.lang.String expressionName) An Expression object, fully populated with an array of Expression Variables is returned.
ExpressionIf	getExpressionForGuest(int customerId, int expressionId, java.lang.String expressionName) An Expression object, fully populated with an array of Expression Variables is returned.
void	insertCustomerTag(int customerId, CustomerTagIf tag, boolean ignoreSetByAPI) Assigns a customer tag to the customer referenced by the customerId.
void	insertCustomerTag(java.lang.String sessionId, CustomerTagIf tag) Assigns a customer tag to the customer referenced by the sessionId.
void	insertCustomerTagForGuest(int customerId, CustomerTagIf tag) Assigns a customer tag to the guest customer referenced by the customerId which must have a negative value.

Method Detail

insertCustomerTag

void insertCustomerTag(java.lang.String sessionId,
                       CustomerTagIf tag)
                throws java.lang.Exception

Assigns a customer tag to the customer referenced by the sessionId. If a tag already exists with this name, then the value is replaced with the new value. The compulsory tag fields are:

• name
• value

Note that a customer tag with name tag.getName() must exist in the database since it is used to validate tag.getValue().

Parameters:

sessionId - the sessionId

tag - the tag

Throws:

java.lang.Exception - an unexpected exception

insertCustomerTag

void insertCustomerTag(int customerId,
                       CustomerTagIf tag,
                       boolean ignoreSetByAPI)
                throws java.lang.Exception

Assigns a customer tag to the customer referenced by the customerId. If a tag already exists with this name, then the value is replaced with the new value. The compulsory tag fields are:

• name
• value

Note that a customer tag with name tag.getName() must exist in the database since it is used to validate tag.getValue().

Parameters:

customerId - the customerId

tag - the tag

ignoreSetByAPI - Allows you to set the value directly from the manager even if the SetByAPI flag for the tag is false

Throws:

java.lang.Exception - an unexpected exception

insertCustomerTagForGuest

void insertCustomerTagForGuest(int customerId,
                               CustomerTagIf tag)
                        throws java.lang.Exception

Assigns a customer tag to the guest customer referenced by the customerId which must have a negative value.

If a tag already exists with this name, then the value is replaced with the new value. The compulsory tag fields are:

• name
• value

Note that a customer tag with name tag.getName() must exist in the database since it is used to validate tag.getValue().

Parameters:

customerId - the customerId

tag - the tag

Throws:

java.lang.Exception - an unexpected exception

addToCustomerTag

void addToCustomerTag(java.lang.String sessionId,
                      java.lang.String tagName,
                      int tagValue)
               throws java.lang.Exception

This method is used for customer tags where the value is of type com.konakart.app.CustomerTag.MULTI_INT_TYPE or MULTI_INT_PLUS_TIME_TYPE. This customer tag type is used to store a series of integers and is useful for cases where you want to store information such as the last 5 product ids that a customer looked at.
If the customer tag doesn't yet exist for the customer referenced by the sessionId, then a new customer tag is added with the value in the tagValue parameter. Otherwise the new value is added. When the number of integers stored reaches the maximum value defined for the customer tag, then the new value is added and the oldest value is removed.

In the case of MULTI_INT_PLUS_TIME_TYPE tags, the timestamp component is added on the server so does not need to be specified.

Parameters:

sessionId - the sessionId

tagName - the tagName

tagValue - the tagValue

Throws:

java.lang.Exception - an unexpected exception

addToCustomerTag

void addToCustomerTag(int customerId,
                      java.lang.String tagName,
                      int tagValue)
               throws java.lang.Exception

This method is used for customer tags where the value is of type com.konakart.app.CustomerTag.MULTI_INT_TYPE or MULTI_INT_PLUS_TIME_TYPE. This customer tag type is used to store a series of integers and is useful for cases where you want to store information such as the last 5 product ids that a customer looked at.
If the customer tag doesn't yet exist for the customer referenced by the sessionId, then a new customer tag is added with the value in the tagValue parameter. Otherwise the new value is added. When the number of integers stored reaches the maximum value defined for the customer tag, then the new value is added and the oldest value is removed.

In the case of MULTI_INT_PLUS_TIME_TYPE tags, the timestamp component is added on the server so does not need to be specified.

Parameters:

customerId - the customerId

tagName - the tagName

tagValue - the tagValue

Throws:

java.lang.Exception - an unexpected exception

addToCustomerTagForGuest

void addToCustomerTagForGuest(int customerId,
                              java.lang.String tagName,
                              int tagValue)
                       throws java.lang.Exception

This method is used for customer tags where the value is of type com.konakart.app.CustomerTag.MULTI_INT_TYPE or MULTI_INT_PLUS_TIME_TYPE. This customer tag type is used to store a series of integers and is useful for cases where you want to store information such as the last 5 product ids that a customer looked at.

If the customer tag doesn't yet exist for the guest customer referenced by the customerId (negative value), then a new customer tag is added with the value in the tagValue parameter. Otherwise the new value is added. When the number of integers stored reaches the maximum value defined for the customer tag, then the new value is added and the oldest value is removed.

In the case of MULTI_INT_PLUS_TIME_TYPE tags, the timestamp component is added on the server so does not need to be specified.

Parameters:

customerId - the customerId

tagName - the tagName

tagValue - the tagValue

Throws:

java.lang.Exception - an unexpected exception

getCustomerTag

CustomerTagIf getCustomerTag(java.lang.String sessionId,
                             java.lang.String tagName)
                      throws java.lang.Exception

A CustomerTag object referenced by the parameter tagName is returned. The value attribute of the tag is populated for the customer referenced by the sessionId. If sessionId is set to null, then a customer tag object with a null value is returned. The CustomerTag object contains utility methods to convert the tag string into its original type (i.e. Date, boolean, int etc.).

Parameters:

sessionId - the sessionId

tagName - the tagName

Returns:

Returns a CustomerTag object, populated with the value.

Throws:

java.lang.Exception - an unexpected exception

getCustomerTag

CustomerTag getCustomerTag(int customerId,
                           java.lang.String tagName,
                           boolean getValue)
                    throws java.lang.Exception

A CustomerTag object referenced by the parameter tagName is returned. The value attribute of the tag is populated for the customer referenced by the customerId. The CustomerTag object contains utility methods to convert the tag string into its original type (i.e. Date, boolean, int etc.).

Parameters:

customerId - the customerId

tagName - the tagName

getValue - When true, we attempt to get the value of the tag

Returns:

Returns a CustomerTag object

Throws:

java.lang.Exception - an unexpected exception

getCustomerTagForGuest

CustomerTagIf getCustomerTagForGuest(int customerId,
                                     java.lang.String tagName)
                              throws java.lang.Exception

A CustomerTag object referenced by the parameter tagName is returned. The value attribute of the tag is populated for the guest customer referenced by the negative customerId.

The CustomerTag object contains utility methods to convert the tag string into its original type (i.e. Date, boolean, int etc.).

Parameters:

customerId - the customerId

tagName - the tagName

Returns:

Returns a CustomerTag object, populated with the value.

Throws:

java.lang.Exception - an unexpected exception

getCustomerTagValue

java.lang.String getCustomerTagValue(java.lang.String sessionId,
                                     java.lang.String tagName)
                              throws java.lang.Exception

A string is returned containing the value of the customer tag referenced by the parameter tagName and for the customer referenced by the sessionId. This method is faster than the getCustomerTag method, but the actual CustomerTag object isn't available to convert the String into a more usable form such as boolean or date.

Parameters:

sessionId - the sessionId

tagName - the tagName

Returns:

Returns a string containing the tag value

Throws:

java.lang.Exception - an unexpected exception

getCustomerTagValue

java.lang.String getCustomerTagValue(int customerId,
                                     java.lang.String tagName)
                              throws java.lang.Exception

A string is returned containing the value of the customer tag referenced by the parameter tagName and for the customer referenced by the customerId. This method is faster than the getCustomerTag method, but the actual CustomerTag object isn't available to convert the String into a more usable form such as boolean or date.

Parameters:

customerId - the customerId

tagName - the tagName

Returns:

Returns a string containing the tag value

Throws:

java.lang.Exception - an unexpected exception

getCustomerTagValueForGuest

java.lang.String getCustomerTagValueForGuest(int customerId,
                                             java.lang.String tagName)
                                      throws java.lang.Exception

A string is returned containing the value of the customer tag referenced by the parameter tagName and for the guest customer referenced by the negative customerId. This method is faster than the getCustomerTag method, but the actual CustomerTag object isn't available to convert the String into a more usable form such as boolean or date.

Parameters:

customerId - the customerId

tagName - the tagName

Returns:

Returns a string containing the tag value

Throws:

java.lang.Exception - an unexpected exception

deleteCustomerTag

void deleteCustomerTag(java.lang.String sessionId,
                       java.lang.String tagName)
                throws java.lang.Exception

This method deletes the customer tag referenced by the parameter tagName and for the customer referenced by the sessionId.

Parameters:

sessionId - the sessionId

tagName - the tagName

Throws:

java.lang.Exception - an unexpected exception

deleteCustomerTagForGuest

void deleteCustomerTagForGuest(int customerId,
                               java.lang.String tagName)
                        throws java.lang.Exception

This method deletes the customer tag referenced by the parameter tagName and for the guest customer referenced by the negative customerId.

Parameters:

customerId - the customerId

tagName - the tagName

Throws:

java.lang.Exception - an unexpected exception

getCustomerTags

CustomerTagIf[] getCustomerTags(java.lang.String sessionId)
                         throws java.lang.Exception

This method fetches all of the customer tags for the customer referenced by the sessionId.
An empty array is returned if no tags exist.

Parameters:

sessionId - the sessionId

Returns:

Returns an array of CustomerTag objects

Throws:

java.lang.Exception - an unexpected exception

getCustomerTags

CustomerTagIf[] getCustomerTags(int customerId)
                         throws java.lang.Exception

This method fetches all of the customer tags for the customer referenced by the customerId.
An empty array is returned if no tags exist.

Parameters:

customerId - the customerId

Returns:

Returns an array of CustomerTag objects

Throws:

java.lang.Exception - an unexpected exception

getCustomerTagsForGuest

CustomerTagIf[] getCustomerTagsForGuest(int customerId)
                                 throws java.lang.Exception

This method fetches all of the customer tags for the guest customer referenced by the customerId which must have a negative value.

An empty array is returned if no tags exist.

Parameters:

customerId - the customerId

Returns:

Returns an array of CustomerTag objects

Throws:

java.lang.Exception - an unexpected exception

evaluateExpression

boolean evaluateExpression(java.lang.String sessionId,
                           int expressionId,
                           java.lang.String expressionName)
                    throws java.lang.Exception

An expression object is retrieved from the database and evaluated for the customer referenced by the sessionId. If the expressionName parameter is not set to null, then the Expression is searched for by name. Otherwise it is searched for by the id contained in the expressionId parameter.

Parameters:

sessionId - the sessionId

expressionId - the expressionId

expressionName - the expressionName

Returns:

Returns true or false

Throws:

java.lang.Exception - an unexpected exception

evaluateExpression

boolean evaluateExpression(int customerId,
                           int expressionId,
                           java.lang.String expressionName)
                    throws java.lang.Exception

An expression object is retrieved from the database and evaluated for the customer referenced by the customerId. If the expressionName parameter is not set to null, then the Expression is searched for by name. Otherwise it is searched for by the id contained in the expressionId parameter.

Parameters:

customerId - the customerId

expressionId - the expressionId

expressionName - the expressionName

Returns:

Returns true or false

Throws:

java.lang.Exception - an unexpected exception

evaluateExpressionForGuest

boolean evaluateExpressionForGuest(int customerId,
                                   int expressionId,
                                   java.lang.String expressionName)
                            throws java.lang.Exception

An expression object is retrieved from the database and evaluated for the guest customer referenced by the negative customerId. If the expressionName parameter is not set to null, then the Expression is searched for by name. Otherwise it is searched for by the id contained in the expressionId parameter.

Parameters:

customerId - the customerId

expressionId - the expressionId

expressionName - the expressionName

Returns:

Returns true or false

Throws:

java.lang.Exception - an unexpected exception

getExpression

ExpressionIf getExpression(java.lang.String sessionId,
                           int expressionId,
                           java.lang.String expressionName)
                    throws java.lang.Exception

An Expression object, fully populated with an array of Expression Variables is returned. If the expressionName parameter is not set to null, then the Expression is searched for by name. Otherwise it is searched for by the id contained in the expressionId parameter. If the sessionId parameter is null we get the expression variables without any customer tag values. Otherwise the expression variables will be populated with the customer tag values for the customer referenced by sessionId. other

Parameters:

sessionId - the sessionId

expressionId - the expressionId

expressionName - the expressionName

Returns:

Returns a fully populated Expression object

Throws:

java.lang.Exception - an unexpected exception

getExpressionForGuest

ExpressionIf getExpressionForGuest(int customerId,
                                   int expressionId,
                                   java.lang.String expressionName)
                            throws java.lang.Exception

An Expression object, fully populated with an array of Expression Variables is returned. If the expressionName parameter is not set to null, then the Expression is searched for by name. Otherwise it is searched for by the id contained in the expressionId parameter.

The expression variables will be populated with the customer tag values for the guest customer referenced by customerId.

Parameters:

customerId - the customerId

expressionId - the expressionId

expressionName - the expressionName

Returns:

Returns a fully populated Expression object

Throws:

java.lang.Exception - an unexpected exception

getExpression

ExpressionIf getExpression(int custId,
                           int expressionId,
                           java.lang.String expressionName)
                    throws java.lang.Exception

An Expression object, fully populated with an array of Expression Variables is returned. If the expressionName parameter is not set to null, then the Expression is searched for by name. Otherwise it is searched for by the id contained in the expressionId parameter. The expression variables will be populated with the customer tag values for the customer referenced by custId. other

Parameters:

custId - the custId

expressionId - the expressionId

expressionName - the expressionName

Returns:

Returns a fully populated Expression object

Throws:

java.lang.Exception - an unexpected exception