atg.svc.ui.formhandlers
Class SolutionSearchFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.droplet.TransactionalFormHandler
                      atg.web.formhandlers.ApplicationFormHandler
                          atg.svc.ui.formhandlers.ServiceFormHandler
                              atg.svc.ui.formhandlers.FrameworkBaseFormHandler
                                  atg.svc.ui.formhandlers.SearchBaseFormHandler
                                      atg.svc.ui.formhandlers.SolutionSearchFormHandler

All Implemented Interfaces:

atg.droplet.DropletFormHandler, 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, FormHandlerConstants, TreeTableFormHandler, Listable, Pageable, Sortable, java.util.EventListener

Direct Known Subclasses:

ToolbarFormHandler

public class SolutionSearchFormHandler
extends SearchBaseFormHandler

Performs structured search for solutions using ATG Search product.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mCreationRelation
protected java.lang.String	mLastModifiedRelation
protected boolean	mUseSolutionClassesConstraint

Fields inherited from class atg.svc.ui.formhandlers.SearchBaseFormHandler

ACTIVE_CONSTRAINTS, CONSTRAINT_STATE_ACTIVE, CONSTRAINT_STATE_INACTIVE, CONSTRAINT_STATE_UNINITIALIZED, CONSTRAINT_TYPE_CREATION_DATE, CONSTRAINT_TYPE_FAVORITE_QUERY, CONSTRAINT_TYPE_FORMAT, CONSTRAINT_TYPE_KEYWORD, CONSTRAINT_TYPE_LAST_MODIFIED_DATE, CONSTRAINT_TYPE_QUERY_LANGUAGE, CONSTRAINT_TYPE_RESULT_LANGUAGE, CONSTRAINT_TYPE_TOPIC, DEFAULT_PAGE_SIZE, KNOWLEDGE_QUERY_CONTEXT_BROWSE_BUILDER_WINDOW_STATE_KEY, KNOWLEDGE_QUERY_CONTEXT_CONTRIBUTE_WINDOW_STATE_KEY, KNOWLEDGE_QUERY_CONTEXT_QUERY_BUILDER_WINDOW_STATE_KEY, KNOWLEDGE_QUERY_CONTEXT_REVIEW_QUERY_BUILDER_WINDOW_STATE_KEY, KNOWLEDGE_QUERY_CONTEXT_WINDOW_STATE_KEY, LAST_SEARCH_INFO_KEY, mActiveConstraints, mAuthor, mAuthorOp, mBestBets, mCreationDateFrom, mCreationDateTo, mCreationDateType, mCustomSortDefaultField, mCustomSortField, mDisabledSolutionClasses, mDocumentFormats, mExternalAudience, mExternalAudienceOp, mFavoriteQuery, mFieldNames, mFieldOperations, mFieldValues, mFieldValues2, mFocusTopic, mGroupByDocument, mInternalAudience, mInternalAudienceOp, mIsBrowsing, mIsExternal, mKeywordAllOfTheWords, mKeywordAtLeastOneOfTheWords, mKeywordNotTheWords, mKnowledgeQueryContext, mLanguageQuery, mLanguageResults, mLastModifiedDateFrom, mLastModifiedDateTo, mLastModifiedDateType, mListCreationRange, mListLastModifiedRange, mModifiedBy, mModifiedByOp, mOperation, mOwningGroup, mOwningGroupOp, mPageSize, mProfileService, mQueryConstraints, mQueryId, mQueryName, mSearchAllTopics, mSearchInfoKey, mSearchResults, mSearchService, mSearchTextInputFields, mSearchTextValues, mShowAnswers, mSolutionClasses, mSolutionLanguage, mSolutionLanguageOp, mSortDirection, mSortField, mState, mStateContainer, mStatuses, mStatusesOp, mTitle, mTitleHasValue, mTitleMatchCase, mTitleOp, mTopics, mTopicService, mTopicsOp, mTotalSize, mTreeTableId, mUseAuthorConstraint, mUseBestBetsConstraint, mUseCountRelation, mUseCountValue, mUseCountValue2, mUseCreationDateConstraint, mUseDisabledSolutionClassesConstraint, mUseExternalAudienceConstraint, mUseFormatConstraint, mUseInternalAudienceConstraint, mUseKeywordConstraint, mUseLastModifiedDateConstraint, mUseModifiedByConstraint, mUseOwningGroupConstraint, mUseQueryConstraint, mUseResultLanguageConstraint, mUseSearchLanguageConstraint, mUseSolutionLanguageConstraint, mUseStatusConstraint, mUseTitleConstraint, mUseTopicConstraint, mUseTopicsConstraint, mUseUseCountConstraint, mUseViewCountConstraint, mView, mViewCountRelation, mViewCountValue, mViewCountValue2, mViewItems, SEARCH_INFO_KEYS, SEARCH_QUERY_BUILDER, SEARCH_QUERY_REVIEW_BUILDER, SEARCH_TASK_QUERY

Fields inherited from class atg.svc.ui.formhandlers.ServiceFormHandler

PERFMON_OP_FORM_HANDLER

Fields inherited from class atg.web.formhandlers.ApplicationFormHandler

EQUALS, PARAM_DELIMITER, QUERY_DELIMITER, STATUS_ERROR_REDIRECT, STATUS_ERROR_STAY, STATUS_SUCCESS

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.svc.ui.formhandlers.FormHandlerConstants

OPTIONS_ANSWER_DISPLAY, OPTIONS_ANSWER_DISPLAY_CURRENT_WINDOW, OPTIONS_ANSWER_DISPLAY_MULTIPLE_WINDOWS, OPTIONS_ANSWER_DISPLAY_SINGLE_WINDOW, OPTIONS_FILTER_BY_DOC_SET, OPTIONS_FILTER_BY_FORMAT, OPTIONS_FILTER_BY_SOURCE, OPTIONS_FILTER_BY_TITLE, OPTIONS_FILTER_OR_GROUPING_FILTER, OPTIONS_FILTER_OR_GROUPING_GROUP, OPTIONS_FILTER_OR_GROUPING_NONE, OPTIONS_QUERY_LANGUAGE, OPTIONS_RESULT_LANGUAGE, OPTIONS_SHOW_ANSWERS_AS, OPTIONS_SHOW_ANSWERS_BY_DOC, OPTIONS_SHOW_ANSWERS_INDIVIDUAL, OPTIONS_SHOW_FAQS_AS_QUESTIONS, OPTIONS_SHOW_FAQS_AS_QUESTIONS_AND_ANSWERS, PARAM_SITE_ID

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

SolutionSearchFormHandler()

Method Summary

java.lang.String	getCreationRelation()
java.lang.String	getLastModifiedRelation()
SolutionService	getSolutionService()
boolean	handleRunSavedQuery(atg.servlet.DynamoHttpServletRequest request, atg.servlet.DynamoHttpServletResponse response) handles search using the saved favorite query, defined by getQueryId()
boolean	handleSolutionSearch(atg.servlet.DynamoHttpServletRequest request, atg.servlet.DynamoHttpServletResponse response) handles search using the predicates (favorite query isn't saved, predicates collected from 'this')
boolean	isUseSolutionClassesConstraint()
void	page(int pStartIndex, int pPageSize) calculates items to diplay on the current page
void	setCreationRelation(java.lang.String pCreationRelation)
void	setLastModifiedRelation(java.lang.String pLastModifiedRelation)
void	setSolutionService(SolutionService pSolutionService)
void	setUseSolutionClassesConstraint(boolean pUseSolutionClassesConstraint)

Methods inherited from class atg.svc.ui.formhandlers.SearchBaseFormHandler

addDateCreatedMinPredicate, addDateModifiedMinPredicate, formHandlerInit, getActiveConstraints, getAdvancedConstraintsAsXml, getAdvancedNonSolutionConstraintsAsXml, getAdvancedSolutionConstraintsAsXml, getAudience, getAudienceOp, getAuthor, getAuthorOp, getBrowseDefaultSortDirection, getBrowseDefaultSortField, getConstraintStateActive, getConstraintStateInactive, getConstraintStateUninitialized, getCreationDateConstraintType, getCreationDateFrom, getCreationDateTo, getCreationDateType, getDisabledSolutionClasses, getDisabledSolutionClassesOp, getDocumentFormats, getEventTools, getExternalAudience, getExternalAudienceOp, getFavoriteQuery, getFavoriteQueryConstraintType, getFieldDefinition, getFieldNames, getFieldOperations, getFieldValues, getFieldValues2, getFocusTopic, getFormatConstraintType, getGroupByDocument, getHasActiveConstraints, getHasDocumentFormats, getHasKeywords, getHasSearchTextInputFields, getHasSearchTextValues, getHasSolutionClasses, getHasTopics, getInternalAudience, getInternalAudienceOp, getIsBrowsing, getIsConstraintTypeActive, getIsConstraintTypeInitialized, getIsCreationDateConstraintActive, getIsCreationDateConstraintInitialized, getIsExternal, getIsFavoriteQueryConstraintActive, getIsFavoriteQueryConstraintInitialized, getIsFormatConstraintActive, getIsFormatConstraintInitialized, getIsKeywordConstraintActive, getIsKeywordConstraintInitialized, getIsLastModifiedDateConstraintActive, getIsLastModifiedDateConstraintInitialized, getIsQueryLanguageConstraintActive, getIsQueryLanguageConstraintInitialized, getIsResultLanguageConstraintActive, getIsResultLanguageConstraintInitialized, getIsTopicConstraintActive, getIsTopicConstraintInitialized, getKeywordAllOfTheWords, getKeywordAtLeastOneOfTheWords, getKeywordConstraintType, getKeywordNotTheWords, getKnowledgeContributeForWindow, getKnowledgeQueryContext, getKnowledgeQueryContextBrowseForWindow, getKnowledgeQueryContextForWindow, getLanguageQuery, getLanguageResults, getLastModifiedDateConstraintType, getLastModifiedDateFrom, getLastModifiedDateTo, getLastModifiedDateType, getListCreationRange, getListLastModifiedRange, getModifiedBy, getModifiedByOp, getOperation, getOwningGroup, getOwningGroupOp, getPageSize, getProfileService, getQueryConstraints, getQueryId, getQueryLanguageConstraintType, getQueryName, getResultLanguageConstraintType, getSearchAllTopics, getSearchDefaultSortDirection, getSearchDefaultSortField, getSearchInfoKey, getSearchResults, getSearchService, getSearchTextInputFields, getSearchTextValues, getSearchType, getShowAnswers, getSolutionClasses, getSolutionLanguage, getSolutionLanguageOp, getSolutionMetadataService, getSortField, getState, getStateContainer, getStatus, getStatuses, getStatusesOp, getStatusOp, getTitle, getTitleHasValue, getTitleOp, getTopicConstraintType, getTopics, getTopicService, getTopicsOp, getTotalItemCount, getTreeTableId, getUseCountRelation, getUseCountValue, getUseCountValue2, getUseCreationDateConstraint, getUseFormatConstraint, getUseKeywordConstraint, getUseLastModifiedDateConstraint, getUseQueryConstraint, getUseResultLanguageConstraint, getUserOptionsService, getUseSearchLanguageConstraint, getUseTopicConstraint, getView, getViewCountRelation, getViewCountValue, getViewCountValue2, getViewItemCount, getViewItems, initializeActiveConstraints, initializeAdvancedConstriants, initializeCreationDateConstraint, initializeDocumentFormats, initializeFavoriteQuery, initializeFocusTopic, initializeKeywords, initializeKnowledgeQueryContext, initializeLastModifiedDate, initializeQueryLanguage, initializeResultLanguage, initializeSolutionClasses, initializeTopics, isBestBets, isFireSearchMessage, isTitleMatchCase, isUseAudienceConstraint, isUseAuthorConstraint, isUseBestBetsConstraint, isUseDisabledSolutionClassesConstraint, isUseExternalAudienceConstraint, isUseInternalAudienceConstraint, isUseModifiedByConstraint, isUseOwningGroupConstraint, isUseSolutionLanguageConstraint, isUseStatusConstraint, isUseTitleConstraint, isUseTopicsConstraint, isUseUseCountConstraint, isUseViewCountConstraint, restoreSearchInfo, saveSearchInfo, setActiveConstraints, setAdvancedConstraintsAsXml, setAdvancedNonSolutionConstraintsAsXml, setAdvancedSolutionConstraintsAsXml, setAudience, setAudienceOp, setAuthor, setAuthorOp, setBestBets, setBrowseDefaultSortDirection, setBrowseDefaultSortField, setCreationDateFrom, setCreationDateTo, setCreationDateType, setCustomSortDefaultField, setCustomSortField, setDisabledSolutionClasses, setDocumentFormats, setEventTools, setExternalAudience, setExternalAudienceOp, setFavoriteQuery, setFieldNames, setFieldOperations, setFieldValues, setFieldValues2, setFireSearchMessage, setFocusTopic, setGroupByDocument, setIgnoreCase, setInternalAudience, setInternalAudienceOp, setIsBrowsing, setIsExternal, setKeywordAllOfTheWords, setKeywordAtLeastOneOfTheWords, setKeywordNotTheWords, setKnowledgeContributeForWindow, setKnowledgeQueryContext, setKnowledgeQueryContextBrowseForWindow, setKnowledgeQueryContextForWindow, setLanguageQuery, setLanguageResults, setLastModifiedDateFrom, setLastModifiedDateTo, setLastModifiedDateType, setLastSearch, setListCreationRange, setListLastModifiedRange, setModifiedBy, setModifiedByOp, setOperation, setOwningGroup, setOwningGroupOp, setPageSize, setProfileService, setQueryConstraints, setQueryId, setQueryName, setSearchAllTopics, setSearchDefaultSortDirection, setSearchDefaultSortField, setSearchInfoKey, setSearchResults, setSearchService, setSearchTextInputFields, setSearchTextValues, setSearchType, setShowAnswers, setSolutionClasses, setSolutionLanguage, setSolutionLanguageOp, setSolutionMetadataService, setSortDirection, setSortField, setState, setStateContainer, setStatus, setStatuses, setStatusesOp, setStatusOp, setTitle, setTitleHasValue, setTitleMatchCase, setTitleOp, setTopics, setTopicService, setTopicsOp, setTreeTableId, setUseAudienceConstraint, setUseAuthorConstraint, setUseBestBetsConstraint, setUseCountRelation, setUseCountValue, setUseCountValue2, setUseCreationDateConstraint, setUseDisabledSolutionClassesConstraint, setUseExternalAudienceConstraint, setUseFormatConstraint, setUseInternalAudienceConstraint, setUseKeywordConstraint, setUseLastModifiedDateConstraint, setUseModifiedByConstraint, setUseOwningGroupConstraint, setUseQueryConstraint, setUseResultLanguageConstraint, setUserOptionsService, setUseSearchLanguageConstraint, setUseSolutionLanguageConstraint, setUseStatusConstraint, setUseTitleConstraint, setUseTopicConstraint, setUseTopicsConstraint, setUseUseCountConstraint, setUseViewCountConstraint, setView, setViewCountRelation, setViewCountValue, setViewCountValue2, updateDateBasedOnRange

Methods inherited from class atg.svc.ui.formhandlers.FrameworkBaseFormHandler

getErrorURL, getParameterMap, getParameters, handleChangeTab, handleCloseWindow, handleGetWindowTab, handleHidePanel, handleProcessPanel, handleScrollPanelTabsLeft, handleScrollPanelTabsRight, handleSelectTabbedPanel, handleShowPanel, handleToggleCell, handleTogglePanel, handleTogglePanelContent, handleTogglePanelsToTabs, handleTransform, setErrorURL, setParameterMap, setParameters

Methods inherited from class atg.svc.ui.formhandlers.ServiceFormHandler

handleUncheckedFormException, isLoggingUncheckedException, isRollbackTransactionOnFormError, isTransactionMarkedAsRollback, processException, processException, setLoggingUncheckedException, setRollbackTransactionOnFormError

Methods inherited from class atg.web.formhandlers.ApplicationFormHandler

addParameterToURLString, beforeGet, beforeSet, checkFormError, checkFormRedirect, checkFormSuccess, formHandlerBeforeGet, formHandlerBeforeSet, getRedirectDelayMS, getString, getString, getString, getSuccessURL, getUserMessagesResourceBundle, handleCancel, processException, processException, processExceptionAndLog, processExceptionAndLog, redirect, setRedirectDelayMS, setSuccessURL, setUserMessagesResourceBundle

Methods inherited from class atg.droplet.TransactionalFormHandler

afterSet, commitTransaction, getTransactionDemarcation, getTransactionStatus, isEnsureTransaction, isRollbackTransaction, isRollbackTransactionOnUnhandledException, setEnsureTransaction, setRollbackTransaction, setRollbackTransactionOnUnhandledException, setTransactionDemarcation

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet

Methods inherited from class atg.nucleus.GenericService

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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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

Methods inherited from interface atg.svc.ui.formhandlers.TreeTableFormHandler

getParameters, setParameters

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mCreationRelation

protected java.lang.String mCreationRelation

mLastModifiedRelation

protected java.lang.String mLastModifiedRelation

mUseSolutionClassesConstraint

protected boolean mUseSolutionClassesConstraint

Constructor Detail

SolutionSearchFormHandler

public SolutionSearchFormHandler()

Method Detail

getSolutionService

public SolutionService getSolutionService()

setSolutionService

public void setSolutionService(SolutionService pSolutionService)

getCreationRelation

public java.lang.String getCreationRelation()

setCreationRelation

public void setCreationRelation(java.lang.String pCreationRelation)

getLastModifiedRelation

public java.lang.String getLastModifiedRelation()

setLastModifiedRelation

public void setLastModifiedRelation(java.lang.String pLastModifiedRelation)

isUseSolutionClassesConstraint

public boolean isUseSolutionClassesConstraint()

setUseSolutionClassesConstraint

public void setUseSolutionClassesConstraint(boolean pUseSolutionClassesConstraint)

page

public void page(int pStartIndex,
                 int pPageSize)

calculates items to diplay on the current page

Specified by:

page in interface Pageable

Specified by:

page in class SearchBaseFormHandler

Parameters:

pStartIndex -

pPageSize -

handleSolutionSearch

public boolean handleSolutionSearch(atg.servlet.DynamoHttpServletRequest request,
                                    atg.servlet.DynamoHttpServletResponse response)
                             throws java.lang.Exception

handles search using the predicates (favorite query isn't saved, predicates collected from 'this')

Throws:

java.lang.Exception

handleRunSavedQuery

public boolean handleRunSavedQuery(atg.servlet.DynamoHttpServletRequest request,
                                   atg.servlet.DynamoHttpServletResponse response)
                            throws java.lang.Exception

handles search using the saved favorite query, defined by getQueryId()

Throws:

java.lang.Exception