atg.svc.repository.service
Class SolutionScoringService

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.svc.repository.service.BaseService
              atg.svc.repository.service.SharedService
                  atg.svc.repository.service.SolutionScoringService

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

Direct Known Subclasses:

AsyncSolutionScoringService

@Service(requiredProperties={"qOAAService","optionService","searchLanguageService","searchService","solutionSecurityUtils","solutionService"})
public class SolutionScoringService
extends SharedService

Maintains the solution scoring. Also supports the retrieval of the the pre-defined solution lists

• Questions Others Are Asking (QOAA)
• Top Solutions
• Hot Solutions

The lists:

• Questions Others Are Asking (QOAA) - This list returns the solutions that are marked only as best bets or specifically defined for certain soltions. The list can be obtained for all the solutions or for a specific solution class sorted by the score as defined in the QOAA formula as defined by the configuration property listFormula.
• Top Solutions - This list returns the solutions are satisfy the score computed by the top solution formula. The list can obtained for all the solutions or for a specific solution class sorted by the score as defined in the top solution formula as defined by the configuration property listFormula.
• Hot Solutions - This list returns the solutions are satisfy the score computed by the hot solution formula. The list can obtained for all the solutions or for a specific solution class sorted by the score as defined in the hot solution formula as defined by the configuration property listFormula.

Currently, other kind of list are not supported.

Updating the solution use count

The use count as defined means how many times a particular solution is refered to by a problem object. Hence, whenever a solution is linked to a problem the solution's use count should be incremented via incrementUseCount and whenever a solution is unlinked from a problem the use count should be decremented via decrementViewCount

Updating the solution view count

The view count as defined means how many times a particular solution is viewed. Hence, whenever a solution is viewed the solution's view count should be incremented via incrementViewCount. View count never decreases.

Updating the solution hot use count

Hot Use Count as defined means how many times a particular solution has been referred to within the specified duration in days in the past. For this a scheduler service needs to be run that will refresh the hot use count. This service would compute the hot use count and set the hot use count.

Issue: While updating the solution's hot use count it is possible that it's use/view count may change before saving the solution relevance object as a result a stale value for use/view count may get persisted. If the solution's use count changed, it may not be considered while computing the hot use count.

Defining the Utility Formulas for Solution's scores per list

When the fomula changes, the solution relevance scores would have to be recomputed.

In order to recompute the score for all the solutions a special method would have to be called that would compute and persist the score in batch mode for every solution relevance object.

Formulas can be defined as per the JEP specs.

There are three type of lists that are supported

1. hot
2. top
3. qoaa all the solution that have been specifically defined as QOAA or are marked as Best Bet When the useBestBetOnly is set to true, explicitly defined QOAAs are ignored.

The service configuration property listFormulas should be used to set the formulas for the each list with the exception of hot solutions list. The service properties file is used to configuration.

The formulas can use the following restricted list of variables that correspond to the properties of solution relevance

1. useCount
2. viewCount
3. hotUseCount

The solution relevance property names are configurable via the following methods

1. For useCount getSolutionRelevanceUseCountPropertyName()
2. For viewCount getSolutionRelevanceViewCountPropertyName()
3. For hotUseCount getSolutionRelevanceHotUseCountPropertyName()

The default formulas are:

1. hot the formula is empty and when it is not defined in this list, the one defined via the admin option is used. useCountWeight*hotUseCount+viewCountWeight*viewCount useCountWeight is provided via the admin option specified via getHotUseCountWeightPropertyName() viewCountWeight is provided via the admin option specified via getHotViewCountWeightPropertyName()
2. top the formula is viewCount
3. qoaathe formula is useCount

Defining the duration for Hot Counts

For hot use count durations can be specified via the admin option in days. The admin option is specified via getHotUseCountDurationPropertyName()

1. Hot use count duration reads the site option gives the number of days.

NOTE: Don't call incrementUseCount or decrementUseCount directly. The use count is updated when you save a RecommendedAnswer that uses a solution. @see atg.svc.repository.service.RecommendedAnswerService#saveRecommendedAnswer(RecommendedAnswer, boolean)RecommendedAnswer(RecommendedAnswer, boolean)(RecommendedAnswer, boolean) NOTE: We did not previously have a base exception class in ATG Service that we threw. To allow for new exceptions to be thrown, we changed the signature of the functions to throw a new SvcException base exception. This will allow us to throw new exceptions in the future without changing the signature of the methods. However, customizations built before 10.0 will need to catch the new SvcException. The PersistenceException, ObjectException and ObjectNotFoundException now sub-class the SvcException. So does the new SolutionFieldStorageException. Methods that previously threw javax.ejb.CreateException, javax.ebj.FinderException or javax.ejb.RemoveException now throw a PersistenceException which is declared as throws SvcException to allow for other SvcExceptions to be thrown in the future.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static int	sLISTORDERING_ASC
static int	sLISTORDERING_DESC
static java.lang.String	sLISTTYPE_HOT
static java.lang.String	sLISTTYPE_QOAA
static java.lang.String	sLISTTYPE_TOP
static java.lang.String	sSOLUTION_SCORING_FILTER_CONTEXT_PATH The component path of the request scoped nucleus component that stores the filter context for filtering hot solutions, top questions and QOAA by topic and solution class.

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

SolutionScoringService()

Method Summary

int	computeHotScore(SolutionRelevance pSolutionRelevance) Computes the hot solution score, but does not update the SolutionRelevance item
int	computeHotUseCount(java.lang.String pSolutionId) Computes the hot use count - the number of times solution was linked in last N days
int	computeQOAAScore(SolutionRelevance pSolutionRelevance) Computes the hot solution score, but does not update the SolutionRelevance item
void	computeScore(SolutionRelevance pSolutionRelevance) Computes the hot, top and qoaa scores and updates those scores in the SolutionRelevance item
int	computeTopScore(SolutionRelevance pSolutionRelevance) Computes the hot solution score, but does not update the SolutionRelevance item
SolutionRelevance	create(Solution pSolution) Creates a new solution relevance bean for the specified solution.
SolutionRelevance	create(java.lang.String pSolutionId) Creates a new solution relevance bean for the specified solution.
SolutionRelevance	create(java.lang.String pSolutionId, java.lang.String pSolutionClassId) Creates a new solution relevance bean for the specified solution.
int	decrementHotUseCount(java.lang.String pSolutionId) Decrements the hot use count for the solution and saves it.
int	decrementUseCount(java.lang.String pSolutionId) Decrements the Use count for the solution and saves it.
SolutionRelevance	findByPrimaryKey(java.lang.String pSolutionRelevanceId) Finds a solution relevance object by the SolutionRelevance repository id.
SolutionRelevance	findBySolutionId(java.lang.String pSolutionId) Finds a solution relevance object by the solution's repository id.
java.util.Collection<SolutionRelevance>	getAllSolutionRelevance()
java.util.Collection<SolutionRelevance>	getBatchSolutionRelevance(java.lang.String pLastSolutionRelevanceId, int pBatchSize)
atg.search.routing.command.search.DocumentSetConstraint[]	getBestBetsCustomConstraints() A list of custom constraint components that can be used to further constrain the best bets (a.k.a.
int	getDefaultMax() Default list size.
int	getDefaultOrdering() The default ordering.
java.util.Locale	getFilterLocale() Sets the locale used to fitler the results.
java.util.List<java.lang.String>	getHotSolutionClasses() get the HotSolutionClasses as configured in the options.
java.lang.String	getHotSolutionClassesPropertyName()
java.util.Collection<Solution>	getHotSolutions() Deprecated. This function is being retained for backward compatibility but you should use getHotSolutionsAsSolutions() instead. Most callers want a list of Solution rather than a list of SolutionRelevance and getHotSolutionsAsSolutions() is more efficient than getting the SolutionRelevance and then retrieving the Solution by id. getHotSolutionsAsSolutions() will also make sure that non-deployed solutions are not returned in self-service. NOTE: If you want to get the SolutionRelevance, you can also get it from Solution.getSolutionRelevance().
java.util.Collection<Solution>	getHotSolutions(java.lang.String pSolutionClassId) Gets the Hot Solutions list
java.util.Collection<Solution>	getHotSolutionsAsSolutions() Gets the Hot Solutions list
java.util.List<Solution>	getHotSolutionsAsSolutions(int pMaxSolutions, java.util.Collection<java.lang.String> pTopicIds, java.util.Collection<java.lang.String> pSolutionClassIds) Gets the Hot Solutions list filtered by constraints and sorted by their hot score.
atg.search.routing.command.search.DocumentSetConstraint[]	getHotSolutionsCustomConstraints() A list of custom constraint components that can be used to further constrain the hot solutions query.
java.util.List<java.lang.String>	getHotSolutionTopics() get the HotSolutionTopics as configured in the options.
java.lang.String	getHotSolutionTopicsPropertyName()
int	getHotUseCountDuration() Get the HotUseCountDuration to be used in the scoring formula as defined in the site options.
java.lang.String	getHotUseCountDurationPropertyName()
int	getHotUseCountWeight() Get the HotUseCountWeight to be used in the scoring formula as defined in the site options.
java.lang.String	getHotUseCountWeightPropertyName()
int	getHotViewCountWeight() Get the HotViewCountWeight to be used in the scoring formula as defined in the site options.
java.lang.String	getHotViewCountWeightPropertyName()
java.util.Map<java.lang.String,java.lang.String>	getListFormulas() Map of the list type (hot, top or qoaa) and a formula to compute the score for that type.
java.util.Map<java.lang.String,java.lang.Object>	getListMax() A map of the list type (valid types are hot, top and qoaa) and the max number of results to be returned for that list type.
int	getListOrderHotSolutions() The order sLISTORDERING_DESC (1) or sLISTORDERING_ASC (2) of the hot solutions list
java.util.Map<java.lang.String,java.lang.Object>	getListOrdering() A map of the list type (hot, top or qoaa) and the list order - either sLISTORDERING_DESC (1) or sLISTORDERING_ASC (2).
int	getListOrderQOAASolutions() The order sLISTORDERING_DESC (1) or sLISTORDERING_ASC (2) of the qoaa list
int	getListOrderTopSolutions() The order sLISTORDERING_DESC (1) or sLISTORDERING_ASC (2) of the top solutions list
java.lang.String[]	getLists() An array of the list types (valid values are hot, top and qoaa)
int	getMaxBestBets()
int	getMaxBestBets(atg.repository.RepositoryItem pProfile)
java.lang.String	getMaxBestBetsPropertyName()
int	getMaxHotSolutions()
int	getMaxHotSolutions(atg.repository.RepositoryItem pProfile)
java.lang.String	getMaxHotSolutionsPropertyName()
int	getMaxTopQuestions()
int	getMaxTopQuestions(atg.repository.RepositoryItem pProfile)
java.lang.String	getMaxTopQuestionsPropertyName()
atg.svc.repository.service.OptionService	getOptionService()
java.util.Collection<Solution>	getQOAAList() Gets the Questions Others are Asking List
QOAAService	getQOAAService()
RecommendedAnswerService	getRecommendedAnswerService()
atg.svc.search.SearchLanguageService	getSearchLanguageService()
atg.svc.search.SearchService	getSearchService()
SolutionRelevance	getSolutionRelevance(java.lang.String pSolutionId) Gets a SolutionRelevance object for the given solution id.
java.lang.String	getSolutionRelevanceHotUseCountPropertyName()
java.lang.String	getSolutionRelevanceUseCountPropertyName()
java.lang.String	getSolutionRelevanceViewCountPropertyName()
atg.svc.repository.service.util.SolutionSecurityUtils	getSolutionSecurityUtils()
SolutionService	getSolutionService()
java.util.Collection<Solution>	getTopSolutions() Deprecated. This function is being retained for backward compatibility but you should use getTopSolutionsAsSolutions() instead. Most callers want a list of Solution rather than a list of SolutionRelevance and getTopSolutionsAsSolutions() is more efficient than getting the SolutionRelevance and then retrieving the Solution by id. getTopSolutionsAsSolutions() will also make sure that non-deployed solutions are not returned in self-service. NOTE: If you want to get the SolutionRelevance, you can also get it from Solution.getSolutionRelevance().
java.util.Collection<Solution>	getTopSolutions(int pMaxSolutions, java.util.Collection<java.lang.String> pTopicIds, java.util.Collection<java.lang.String> pSolutionClassIds) Gets the Top Solutions list filtered by constraints and sorted by their top score.
java.util.Collection<Solution>	getTopSolutions(java.lang.String pSolutionClassId) Gets the Top Solutions list
java.util.Collection<Solution>	getTopSolutionsAsSolutions() Gets the Top Solutions list
java.util.Collection<Solution>	getTopSolutionsAsSolutions(int pMaxSolutions, java.util.Collection<java.lang.String> pTopicIds, java.util.Collection<java.lang.String> pSolutionClassIds) Gets the Top Solutions list filtered by constraints and sorted by their top score.
atg.search.routing.command.search.DocumentSetConstraint[]	getTopSolutionsCustomConstraints() A list of custom constraint components that can be used to further constrain the top solutions query.
int	incrementHotUseCount(java.lang.String pSolutionId) Increments the hot use count for the solution and saves it.
int	incrementUseCount(java.lang.String pSolutionId) Increments the Use count for the solution and saves it.
int	incrementViewCount(java.lang.String pSolutionId) Increments the view count for the solution and saves it.
boolean	isAgentModule()
boolean	isFlexibleHotUseCount()
boolean	isUseBestBetOnly()
void	save(SolutionRelevance pSolutionRelevance) Saves a solution relevance object to the repository.
void	setAgentModule(boolean pAgentModule)
void	setBestBetsCustomConstraints(atg.search.routing.command.search.DocumentSetConstraint[] pBestBetsCustomConstraints)
void	setDefaultMax(int pDefaultMax)
void	setDefaultOrdering(int pDefaultOrdering)
void	setFlexibleHotUseCount(boolean pFlexibleHotUseCount)
void	setHotSolutionClassesPropertyName(java.lang.String pHotSolutionClassesPropertyName)
void	setHotSolutionsCustomConstraints(atg.search.routing.command.search.DocumentSetConstraint[] pHotSolutionsCustomConstraints)
void	setHotSolutionTopicsPropertyName(java.lang.String pHotSolutionTopicsPropertyName)
int	setHotUseCount(java.lang.String pSolutionId, int pHotUseCount) Sets the hot use count for the solution and saves it.
void	setHotUseCountDurationPropertyName(java.lang.String pHotUseCountDurationProperties)
void	setHotUseCountWeightPropertyName(java.lang.String pHotUseCountWeightPropertyName)
void	setHotViewCountWeightPropertyName(java.lang.String pHotViewCountWeightPropertyName)
void	setListFormulas(java.util.Map<java.lang.String,java.lang.String> pListFormulas)
void	setListMax(java.util.Map<java.lang.String,java.lang.Object> pListMax)
void	setListOrdering(java.util.Map<java.lang.String,java.lang.Object> pListOrdering)
void	setLists(java.lang.String[] pLists)
void	setMaxBestBetsPropertyName(java.lang.String pMaxBestBetsPropertyName)
void	setMaxHotSolutionsPropertyName(java.lang.String pMaxHotSolutionsPropertyName)
void	setMaxTopQuestionsPropertyName(java.lang.String pMaxTopQuestionsPropertyName)
void	setOptionService(atg.svc.repository.service.OptionService pOptionService)
void	setQOAAService(QOAAService pQOAAService)
void	setRecommendedAnswerService(RecommendedAnswerService pRecommendedAnswerService)
void	setSearchLanguageService(atg.svc.search.SearchLanguageService pSearchLanguageService)
void	setSearchService(atg.svc.search.SearchService pSearchService)
void	setSolutionRelevanceHotUseCountPropertyName(java.lang.String pSolutionRelevanceHotUseCountPropertyName)
void	setSolutionRelevanceUseCountPropertyName(java.lang.String pSolutionRelevanceUseCountPropertyName)
void	setSolutionRelevanceViewCountPropertyName(java.lang.String pSolutionRelevanceViewCountPropertyName)
void	setSolutionSecurityUtils(atg.svc.repository.service.util.SolutionSecurityUtils pSolutionSecurityUtils)
void	setSolutionService(SolutionService pSolutionService)
void	setTopSolutionsCustomConstraints(atg.search.routing.command.search.DocumentSetConstraint[] pTopSolutionsCustomConstraints)
void	setUseBestBetOnly(boolean pUseBestBetOnly)
int	updateHotUseCount(SolutionRelevance pSolutionRelevance) Updates the hot use count and recomputes the score for the solution and saves the updated SolutionRelevance repository item.
int	updateHotUseCount(java.lang.String pSolutionId) Updates the hot use count and recomputes the score for the solution and saves the updated SolutionRelevance repository item.

Methods inherited from class atg.svc.repository.service.SharedService

getServiceSharedBeanHomes, getServiceSharedBeanHomesName, getServiceSharedRepositoryHomes, getServiceSharedRepositoryHomesName, setServiceSharedBeanHomesName, setServiceSharedRepositoryHomesName

Methods inherited from class atg.svc.repository.service.BaseService

getRepositoryService, getToday, setRepositoryService

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

sLISTTYPE_HOT

public static java.lang.String sLISTTYPE_HOT

sLISTTYPE_TOP

public static java.lang.String sLISTTYPE_TOP

sLISTTYPE_QOAA

public static java.lang.String sLISTTYPE_QOAA

sLISTORDERING_DESC

public static int sLISTORDERING_DESC

sLISTORDERING_ASC

public static int sLISTORDERING_ASC

sSOLUTION_SCORING_FILTER_CONTEXT_PATH

public static java.lang.String sSOLUTION_SCORING_FILTER_CONTEXT_PATH

The component path of the request scoped nucleus component that stores the filter context for filtering hot solutions, top questions and QOAA by topic and solution class. This component is used by the SolutionScoringTopicFilter and SolutionScoringSolutionClassFilter during filtering of hot solutions, top questions and best bets (i.e. questions others are asking - qoaa).

Constructor Detail

SolutionScoringService

public SolutionScoringService()

Method Detail

getRecommendedAnswerService

public RecommendedAnswerService getRecommendedAnswerService()

setRecommendedAnswerService

public void setRecommendedAnswerService(RecommendedAnswerService pRecommendedAnswerService)

getQOAAService

public QOAAService getQOAAService()

setQOAAService

public void setQOAAService(QOAAService pQOAAService)

getOptionService

public atg.svc.repository.service.OptionService getOptionService()

setOptionService

public void setOptionService(atg.svc.repository.service.OptionService pOptionService)

getSearchLanguageService

public atg.svc.search.SearchLanguageService getSearchLanguageService()

setSearchLanguageService

public void setSearchLanguageService(atg.svc.search.SearchLanguageService pSearchLanguageService)

getSearchService

public atg.svc.search.SearchService getSearchService()

setSearchService

public void setSearchService(atg.svc.search.SearchService pSearchService)

getSolutionSecurityUtils

public atg.svc.repository.service.util.SolutionSecurityUtils getSolutionSecurityUtils()

setSolutionSecurityUtils

public void setSolutionSecurityUtils(atg.svc.repository.service.util.SolutionSecurityUtils pSolutionSecurityUtils)

getSolutionService

public SolutionService getSolutionService()

setSolutionService

public void setSolutionService(SolutionService pSolutionService)

isAgentModule

public boolean isAgentModule()

setAgentModule

public void setAgentModule(boolean pAgentModule)

getHotSolutionsCustomConstraints

public atg.search.routing.command.search.DocumentSetConstraint[] getHotSolutionsCustomConstraints()

A list of custom constraint components that can be used to further constrain the hot solutions query. See /atg/svc/repository/service/util/CountryConstraint for an example constraint.

See Also:

CountryConstraint

setHotSolutionsCustomConstraints

public void setHotSolutionsCustomConstraints(atg.search.routing.command.search.DocumentSetConstraint[] pHotSolutionsCustomConstraints)

getTopSolutionsCustomConstraints

public atg.search.routing.command.search.DocumentSetConstraint[] getTopSolutionsCustomConstraints()

A list of custom constraint components that can be used to further constrain the top solutions query.

See Also:

atg.svc.repository.service.util.SolutionScoringConstraintImpl

setTopSolutionsCustomConstraints

public void setTopSolutionsCustomConstraints(atg.search.routing.command.search.DocumentSetConstraint[] pTopSolutionsCustomConstraints)

getBestBetsCustomConstraints

public atg.search.routing.command.search.DocumentSetConstraint[] getBestBetsCustomConstraints()

A list of custom constraint components that can be used to further constrain the best bets (a.k.a. QOAA) query.

See Also:

atg.svc.repository.service.util.SolutionScoringConstraintImpl

setBestBetsCustomConstraints

public void setBestBetsCustomConstraints(atg.search.routing.command.search.DocumentSetConstraint[] pBestBetsCustomConstraints)

getDefaultMax

public int getDefaultMax()

Default list size.

setDefaultMax

public void setDefaultMax(int pDefaultMax)

getDefaultOrdering

public int getDefaultOrdering()

The default ordering. Either sLISTORDERING_DESC (1) or sLISTORDERING_ASC (2). Default is sLISTORDERING_DESC

setDefaultOrdering

public void setDefaultOrdering(int pDefaultOrdering)

getListOrdering

public java.util.Map<java.lang.String,java.lang.Object> getListOrdering()

A map of the list type (hot, top or qoaa) and the list order - either sLISTORDERING_DESC (1) or sLISTORDERING_ASC (2). The value can be either an Integer or a String representing an integer value.

setListOrdering

public void setListOrdering(java.util.Map<java.lang.String,java.lang.Object> pListOrdering)

getListOrderHotSolutions

public int getListOrderHotSolutions()

The order sLISTORDERING_DESC (1) or sLISTORDERING_ASC (2) of the hot solutions list

getListOrderTopSolutions

public int getListOrderTopSolutions()

The order sLISTORDERING_DESC (1) or sLISTORDERING_ASC (2) of the top solutions list

getListOrderQOAASolutions

public int getListOrderQOAASolutions()

The order sLISTORDERING_DESC (1) or sLISTORDERING_ASC (2) of the qoaa list

getLists

public java.lang.String[] getLists()

An array of the list types (valid values are hot, top and qoaa)

setLists

public void setLists(java.lang.String[] pLists)

getListFormulas

public java.util.Map<java.lang.String,java.lang.String> getListFormulas()

Map of the list type (hot, top or qoaa) and a formula to compute the score for that type. In the formula the variable names should be the same as the solution relevance property name as defined by the property names configuration properties. the formula for hot is not included as the default formula is used. If you wish to overide the default formula define one yourself. The default formula for hot solution is useCountWeight*hotUseCount+viewCountWeight*viewCount. The weights and the duration for hot use count are configurable via the site options. See the admin option property names that are used to find the formula for hot solutions.

setListFormulas

public void setListFormulas(java.util.Map<java.lang.String,java.lang.String> pListFormulas)

getListMax

public java.util.Map<java.lang.String,java.lang.Object> getListMax()

A map of the list type (valid types are hot, top and qoaa) and the max number of results to be returned for that list type. Value can be either an Integer or a String representing an integer value

setListMax

public void setListMax(java.util.Map<java.lang.String,java.lang.Object> pListMax)

getMaxHotSolutions

public int getMaxHotSolutions()

Returns:

Returns the maxHotSolutions.

getMaxHotSolutions

public int getMaxHotSolutions(atg.repository.RepositoryItem pProfile)

Returns:

Returns the maxHotSolutions.

getMaxTopQuestions

public int getMaxTopQuestions()

Returns:

Returns the maxTopSolutions.

getMaxTopQuestions

public int getMaxTopQuestions(atg.repository.RepositoryItem pProfile)

Returns:

Returns the maxTopSolutions.

getMaxBestBets

public int getMaxBestBets()

Returns:

Returns the maxQOAASolutions.

getMaxBestBets

public int getMaxBestBets(atg.repository.RepositoryItem pProfile)

Returns:

Returns the maxQOAASolutions.

isFlexibleHotUseCount

public boolean isFlexibleHotUseCount()

Returns:

Returns the flexibleHotUseCount.

setFlexibleHotUseCount

public void setFlexibleHotUseCount(boolean pFlexibleHotUseCount)

Parameters:

pFlexibleHotUseCount - The flexibleHotUseCount to set.

isUseBestBetOnly

public boolean isUseBestBetOnly()

Returns:

Returns the useBestBetOnly.

setUseBestBetOnly

public void setUseBestBetOnly(boolean pUseBestBetOnly)

Parameters:

pUseBestBetOnly - The useBestBetOnly to set.

getHotSolutionClassesPropertyName

public java.lang.String getHotSolutionClassesPropertyName()

Returns:

Returns the hotSolutionClassesPropertyName.

setHotSolutionClassesPropertyName

public void setHotSolutionClassesPropertyName(java.lang.String pHotSolutionClassesPropertyName)

Parameters:

pHotSolutionClassesPropertyName - The hotSolutionClassesPropertyName to set.

getHotSolutionTopicsPropertyName

public java.lang.String getHotSolutionTopicsPropertyName()

Returns:

Returns the hotSolutionTopicsPropertyName.

setHotSolutionTopicsPropertyName

public void setHotSolutionTopicsPropertyName(java.lang.String pHotSolutionTopicsPropertyName)

Parameters:

pHotSolutionTopicsPropertyName - The hotSolutionTopicsPropertyName to set.

getMaxHotSolutionsPropertyName

public java.lang.String getMaxHotSolutionsPropertyName()

setMaxHotSolutionsPropertyName

public void setMaxHotSolutionsPropertyName(java.lang.String pMaxHotSolutionsPropertyName)

getMaxTopQuestionsPropertyName

public java.lang.String getMaxTopQuestionsPropertyName()

setMaxTopQuestionsPropertyName

public void setMaxTopQuestionsPropertyName(java.lang.String pMaxTopQuestionsPropertyName)

getMaxBestBetsPropertyName

public java.lang.String getMaxBestBetsPropertyName()

setMaxBestBetsPropertyName

public void setMaxBestBetsPropertyName(java.lang.String pMaxBestBetsPropertyName)

getHotUseCountDurationPropertyName

public java.lang.String getHotUseCountDurationPropertyName()

Returns:

Returns the hotUseCountDurationProperties.

setHotUseCountDurationPropertyName

public void setHotUseCountDurationPropertyName(java.lang.String pHotUseCountDurationProperties)

Parameters:

pHotUseCountDurationProperties - The hotUseCountDurationProperties to set.

getHotUseCountWeightPropertyName

public java.lang.String getHotUseCountWeightPropertyName()

Returns:

Returns the hotUseCountWeightPropertyName.

setHotUseCountWeightPropertyName

public void setHotUseCountWeightPropertyName(java.lang.String pHotUseCountWeightPropertyName)

Parameters:

pHotUseCountWeightPropertyName - The hotUseCountWeightPropertyName to set.

getHotViewCountWeightPropertyName

public java.lang.String getHotViewCountWeightPropertyName()

Returns:

Returns the hotViewCountWeightPropertyName.

setHotViewCountWeightPropertyName

public void setHotViewCountWeightPropertyName(java.lang.String pHotViewCountWeightPropertyName)

Parameters:

pHotViewCountWeightPropertyName - The hotViewCountWeightPropertyName to set.

getSolutionRelevanceUseCountPropertyName

public java.lang.String getSolutionRelevanceUseCountPropertyName()

Returns:

Returns the solutionRelevanceUseCountPropertyName.

setSolutionRelevanceUseCountPropertyName

public void setSolutionRelevanceUseCountPropertyName(java.lang.String pSolutionRelevanceUseCountPropertyName)

Parameters:

pSolutionRelevanceUseCountPropertyName - The solutionRelevanceUseCountPropertyName to set.

getSolutionRelevanceHotUseCountPropertyName

public java.lang.String getSolutionRelevanceHotUseCountPropertyName()

Returns:

Returns the solutionRelevanceHotUseCountPropertyName.

setSolutionRelevanceHotUseCountPropertyName

public void setSolutionRelevanceHotUseCountPropertyName(java.lang.String pSolutionRelevanceHotUseCountPropertyName)

Parameters:

pSolutionRelevanceHotUseCountPropertyName - The solutionRelevanceHotUseCountPropertyName to set.

getSolutionRelevanceViewCountPropertyName

public java.lang.String getSolutionRelevanceViewCountPropertyName()

Returns:

Returns the solutionRelevanceViewCountPropertyName.

setSolutionRelevanceViewCountPropertyName

public void setSolutionRelevanceViewCountPropertyName(java.lang.String pSolutionRelevanceViewCountPropertyName)

Parameters:

pSolutionRelevanceViewCountPropertyName - The solutionRelevanceViewCountPropertyName to set.

getHotSolutionClasses

public java.util.List<java.lang.String> getHotSolutionClasses()
                                                       throws SvcException,
                                                              ObjectNotFoundException

get the HotSolutionClasses as configured in the options. Check the current user's preferences OptionService.getArrayValue(String) If the option is set to null, an empty list is returned which implies "ALL SOLUTION CLASSES"

Returns:

List of solution class ids

Throws:

SvcException

ObjectNotFoundException

getHotSolutionTopics

public java.util.List<java.lang.String> getHotSolutionTopics()
                                                      throws SvcException

get the HotSolutionTopics as configured in the options. Check the current user's preferences OptionService.getArrayValue(String) If the option is set to null, an empty list is returned which implies "ALL TOPICS"

Returns:

List of topic ids

Throws:

SvcException

getHotUseCountWeight

public int getHotUseCountWeight()
                         throws ObjectNotFoundException,
                                SvcException

Get the HotUseCountWeight to be used in the scoring formula as defined in the site options. Check the current site option value preferences atg.svc.repository.service.SiteService#getIntegerValue(String)

Throws:

ObjectNotFoundException - when the site option getHotUseCountWeightPropertyName() is not found.

SvcException

getHotViewCountWeight

public int getHotViewCountWeight()
                          throws ObjectNotFoundException,
                                 SvcException

Get the HotViewCountWeight to be used in the scoring formula as defined in the site options. Check the current site option value preferences atg.svc.repository.service.SiteService#getIntegerValue(String)

Throws:

ObjectNotFoundException - when the site option getHotViewCountWeightPropertyName() is not found.

SvcException

getHotUseCountDuration

public int getHotUseCountDuration()
                           throws ObjectNotFoundException,
                                  SvcException

Get the HotUseCountDuration to be used in the scoring formula as defined in the site options. Check the current site option value preferences atg.svc.repository.service.SiteService#getIntegerValue(String)

Throws:

ObjectNotFoundException - when the site option getHotUseCountDurationPropertyName() is not found.

SvcException

getHotSolutions

public java.util.Collection<Solution> getHotSolutions()
                                               throws SvcException,
                                                      ObjectNotFoundException

Deprecated. This function is being retained for backward compatibility but you should use getHotSolutionsAsSolutions() instead. Most callers want a list of Solution rather than a list of SolutionRelevance and getHotSolutionsAsSolutions() is more efficient than getting the SolutionRelevance and then retrieving the Solution by id. getHotSolutionsAsSolutions() will also make sure that non-deployed solutions are not returned in self-service.
NOTE: If you want to get the SolutionRelevance, you can also get it from Solution.getSolutionRelevance().

Gets the Hot Solutions list

Returns:

A collection of Solution Releavance objects

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

See Also:

getHotSolutionsAsSolutions()

getHotSolutionsAsSolutions

public java.util.Collection<Solution> getHotSolutionsAsSolutions()
                                                          throws SvcException

Gets the Hot Solutions list

Returns:

A collection of Solution objects

Throws:

SvcException - When an error occurs

getHotSolutions

public java.util.Collection<Solution> getHotSolutions(java.lang.String pSolutionClassId)
                                               throws SvcException,
                                                      ObjectNotFoundException

Gets the Hot Solutions list

Parameters:

pSolutionClass - The solution class RepItem

Returns:

A collection of Solution Releavance objects

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

getHotSolutionsAsSolutions

public java.util.List<Solution> getHotSolutionsAsSolutions(int pMaxSolutions,
                                                           java.util.Collection<java.lang.String> pTopicIds,
                                                           java.util.Collection<java.lang.String> pSolutionClassIds)
                                                    throws SvcException,
                                                           ObjectNotFoundException

Gets the Hot Solutions list filtered by constraints and sorted by their hot score.

Parameters:

pMaxSolutions - The max number of solutions to be returned.

pTopicIds - A collection of topic repIds that will used as filter constraints. Empty or null means all topics

pSolutionClassIds - A collection of solution class repIds that will be used as filter constraints. Empty or null means all solution classes

Returns:

A collection of Solution objects

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

getTopSolutions

public java.util.Collection<Solution> getTopSolutions()
                                               throws SvcException,
                                                      ObjectNotFoundException

Deprecated. This function is being retained for backward compatibility but you should use getTopSolutionsAsSolutions() instead. Most callers want a list of Solution rather than a list of SolutionRelevance and getTopSolutionsAsSolutions() is more efficient than getting the SolutionRelevance and then retrieving the Solution by id. getTopSolutionsAsSolutions() will also make sure that non-deployed solutions are not returned in self-service.
NOTE: If you want to get the SolutionRelevance, you can also get it from Solution.getSolutionRelevance().

Gets the Top Solutions list

Returns:

A collection of Solution Releavance objects

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

See Also:

getTopSolutionsAsSolutions()

getTopSolutions

public java.util.Collection<Solution> getTopSolutions(java.lang.String pSolutionClassId)
                                               throws SvcException,
                                                      ObjectNotFoundException

Gets the Top Solutions list

Parameters:

pSolutionClass - The solution class RepItem

Returns:

A collection of Solution Releavance objects

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

getTopSolutions

public java.util.Collection<Solution> getTopSolutions(int pMaxSolutions,
                                                      java.util.Collection<java.lang.String> pTopicIds,
                                                      java.util.Collection<java.lang.String> pSolutionClassIds)
                                               throws SvcException,
                                                      ObjectNotFoundException

Gets the Top Solutions list filtered by constraints and sorted by their top score.

Parameters:

pMaxSolutions - The max number of solutions to be returned.

pTopicIds - A collection of topic repIds that will used as filter constraints. Empty or null means all topics

pSolutionClassIds - A collection of solution class repIds that will be used as filter constraints. Empty or null means all solution classes

Returns:

A collection of Solution Releavance objects

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

getTopSolutionsAsSolutions

public java.util.Collection<Solution> getTopSolutionsAsSolutions()
                                                          throws SvcException

Gets the Top Solutions list

Returns:

A collection of Solution objects

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

getTopSolutionsAsSolutions

public java.util.Collection<Solution> getTopSolutionsAsSolutions(int pMaxSolutions,
                                                                 java.util.Collection<java.lang.String> pTopicIds,
                                                                 java.util.Collection<java.lang.String> pSolutionClassIds)
                                                          throws SvcException,
                                                                 ObjectNotFoundException

Gets the Top Solutions list filtered by constraints and sorted by their top score.

Parameters:

pMaxSolutions - The max number of solutions to be returned.

pTopicIds - A collection of topic repIds that will used as filter constraints. Empty or null means all topics

pSolutionClassIds - A collection of solution class repIds that will be used as filter constraints. Empty or null means all solution classes

Returns:

A collection of Solution objects

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

getQOAAList

public java.util.Collection<Solution> getQOAAList()
                                           throws SvcException

Gets the Questions Others are Asking List

Returns:

A collection of Solution is returned for both best bets and questions others are asking settings If useBestBetOnly is true, returns only solutions marked as best bets. If false, uses the questions others are asking (QOAA) list.

Throws:

SvcException - When an error occurs

findByPrimaryKey

public SolutionRelevance findByPrimaryKey(java.lang.String pSolutionRelevanceId)
                                   throws ObjectNotFoundException

Finds a solution relevance object by the SolutionRelevance repository id.

Parameters:

pSolutionRelevanceId - The repository id of solution relevance object

Returns:

The SolutionRelevance ReposImpl

Throws:

ObjectNotFoundException - If the id is not found.

findBySolutionId

public SolutionRelevance findBySolutionId(java.lang.String pSolutionId)

Finds a solution relevance object by the solution's repository id.

Parameters:

pSolutionId - The repository id of Solution object

Returns:

The SolutionRelevance ReposImpl or null if the SolutionRelevance doesn't exist

create

public SolutionRelevance create(java.lang.String pSolutionId)
                         throws SvcException,
                                ObjectNotFoundException

Creates a new solution relevance bean for the specified solution. Use save to persist the solution relevance object.

Parameters:

pSolutionId - Solution RepId

Returns:

new SolutionRelevance repository item.

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

create

public SolutionRelevance create(Solution pSolution)
                         throws SvcException

Creates a new solution relevance bean for the specified solution. Use save to persist the solution relevance object.

Parameters:

pSolution - Solution Repository item.

Returns:

new SolutionRelevance repository item.

Throws:

SvcException - When an error occurs

create

public SolutionRelevance create(java.lang.String pSolutionId,
                                java.lang.String pSolutionClassId)
                         throws SvcException

Creates a new solution relevance bean for the specified solution. Use save to persist the solution relevance object.

Parameters:

pSolution - Solution id

pSolutionClassId - SolutionClass id of the solution

Returns:

new SolutionRelevance repository item.

Throws:

SvcException - When an error occurs

getSolutionRelevance

public SolutionRelevance getSolutionRelevance(java.lang.String pSolutionId)
                                       throws SvcException,
                                              ObjectNotFoundException

Gets a SolutionRelevance object for the given solution id. In case it does not exist a new SolutionRelevance object would be created.

Parameters:

pSolutionId - Solution RepId

Returns:

new SolutionRelevance Repository item

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

save

public void save(SolutionRelevance pSolutionRelevance)
          throws SvcException,
                 ObjectNotFoundException

Saves a solution relevance object to the repository. It should have the id. The existing object is updated.

Parameters:

pSolutionRelevance - The solution relevance to save.

Throws:

SvcException

ObjectNotFoundException

incrementUseCount

public int incrementUseCount(java.lang.String pSolutionId)
                      throws SvcException,
                             ObjectNotFoundException

Increments the Use count for the solution and saves it.

Parameters:

pSolutionId - The RepId of the solution

Returns:

the old use count

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

decrementUseCount

public int decrementUseCount(java.lang.String pSolutionId)
                      throws SvcException,
                             ObjectNotFoundException

Decrements the Use count for the solution and saves it.

Parameters:

pSolutionId - The RepId of the solution

Returns:

the old use count

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

incrementViewCount

public int incrementViewCount(java.lang.String pSolutionId)
                       throws SvcException,
                              ObjectNotFoundException

Increments the view count for the solution and saves it.

Parameters:

pSolutionId - The RepId of the solution

Returns:

the old view count

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

computeHotUseCount

public int computeHotUseCount(java.lang.String pSolutionId)
                       throws ObjectNotFoundException,
                              SvcException

Computes the hot use count - the number of times solution was linked in last N days

Parameters:

pSolutionId - The id of the solution

Throws:

ObjectNotFoundException

SvcException

updateHotUseCount

public int updateHotUseCount(java.lang.String pSolutionId)
                      throws SvcException,
                             ObjectNotFoundException

Updates the hot use count and recomputes the score for the solution and saves the updated SolutionRelevance repository item.

Parameters:

pSolutionId - The RepId of the solution

pSolutionClassId - The repId of the SolutionClass

Returns:

the old hot use count

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

updateHotUseCount

public int updateHotUseCount(SolutionRelevance pSolutionRelevance)
                      throws SvcException,
                             ObjectNotFoundException

Updates the hot use count and recomputes the score for the solution and saves the updated SolutionRelevance repository item.

Parameters:

pSolutionId - The RepId of the solution

pSolutionClassId - The repId of the SolutionClass

Returns:

the old hot use count

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

incrementHotUseCount

public int incrementHotUseCount(java.lang.String pSolutionId)
                         throws SvcException,
                                ObjectNotFoundException

Increments the hot use count for the solution and saves it.

Parameters:

pSolutionId - The RepId of the solution

Returns:

the old hot use count

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

decrementHotUseCount

public int decrementHotUseCount(java.lang.String pSolutionId)
                         throws SvcException,
                                ObjectNotFoundException

Decrements the hot use count for the solution and saves it.

Parameters:

pSolutionId - The RepId of the solution

Returns:

the old hot use count

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

setHotUseCount

public int setHotUseCount(java.lang.String pSolutionId,
                          int pHotUseCount)
                   throws SvcException,
                          ObjectNotFoundException

Sets the hot use count for the solution and saves it.

Parameters:

pSolutionId - The RepId of the solution

pHotUseCount -

Returns:

the old hot use count

Throws:

ObjectNotFoundException - When solution not found

SvcException - When an error occurs

computeScore

public void computeScore(SolutionRelevance pSolutionRelevance)
                  throws SvcException

Computes the hot, top and qoaa scores and updates those scores in the SolutionRelevance item

Throws:

SvcException

computeHotScore

public int computeHotScore(SolutionRelevance pSolutionRelevance)
                    throws SvcException

Computes the hot solution score, but does not update the SolutionRelevance item

Returns:

The hot solution score

Throws:

SvcException

computeTopScore

public int computeTopScore(SolutionRelevance pSolutionRelevance)
                    throws SvcException

Computes the hot solution score, but does not update the SolutionRelevance item

Returns:

The top solution score

Throws:

SvcException

computeQOAAScore

public int computeQOAAScore(SolutionRelevance pSolutionRelevance)
                     throws SvcException

Computes the hot solution score, but does not update the SolutionRelevance item

Returns:

The qoaa solution score

Throws:

SvcException

getFilterLocale

public java.util.Locale getFilterLocale()

Sets the locale used to fitler the results. Agent uses the default query locale. Overriden in self-service to use the display language

getAllSolutionRelevance

public java.util.Collection<SolutionRelevance> getAllSolutionRelevance()
                                                                throws SvcException

Throws:

SvcException

getBatchSolutionRelevance

public java.util.Collection<SolutionRelevance> getBatchSolutionRelevance(java.lang.String pLastSolutionRelevanceId,
                                                                         int pBatchSize)
                                                                  throws SvcException

Parameters:

pLastSolutionRelevanceId - - the id of the last item returned in the previous batch or null if this is the first batch. We retrieve items greater than this id.

pBatchSize - - the number of SolutionRelevance to retrieve

Returns:

collection of SolutionRelevance

Throws:

SvcException - When an error occurs