com.tridion.smarttarget.query.builder

Interface QueryListener

public interface QueryListener

Allows custom classes to modify the query before execution and/or modify the result after executing.

 QueryBuilder builder = new QueryBuilder();
 QueryListener listener = new QueryListener() {

     @Override
     public void beforeExecute(BeforeExecuteEventArgs event) throws SmartTargetException {
         try {
             //add a parameter to the query
             ((QueryBuilder)event.getSource()).addCriteria(new CustomParameterCriteria("foo", "bar"));
         } catch (SmartTargetException e) {
             throw new SmartTargetException("error adding criteria to query", e);
         }
     }

     @Override
     public void afterExecute(AfterExecuteEventArgs event) throws SmartTargetException {
         event.getResultSet().getItems().clear();
     }
 };

 builder.addListener(listener);
 ResultSet resultSet = builder.execute();
 

Method Summary

Modifier and Type	Method and Description
void	afterExecute(AfterExecuteEventArgs event) EventHandler called immediately after the Fredhopper query has returned.
void	beforeExecute(BeforeExecuteEventArgs event) EventHandler called just before querying Fredhopper.

Method Detail

beforeExecute

void beforeExecute(BeforeExecuteEventArgs event)
            throws com.tridion.smarttarget.SmartTargetException

EventHandler called just before querying Fredhopper.

Can be used to change the QueryBuilder just before querying Fredhopper.

Parameters:

event - source contains the QueryBuilder.

Throws:

com.tridion.smarttarget.SmartTargetException

afterExecute

void afterExecute(AfterExecuteEventArgs event)
           throws com.tridion.smarttarget.SmartTargetException

EventHandler called immediately after the Fredhopper query has returned.

Can be used to change the ResultSet that represents the Fredhopper query results.

Parameters:

event - source contains the QueryBuilder, resultSet contains the ResultSet.

Throws:

com.tridion.smarttarget.SmartTargetException