atg.svc.ui.formhandlers
Class SearchFormHandler

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.droplet.EmptyFormHandler
              extended by atg.droplet.GenericFormHandler
                  extended by atg.droplet.TransactionalFormHandler
                      extended by atg.web.formhandlers.ApplicationFormHandler
                          extended by atg.svc.ui.formhandlers.ServiceFormHandler
                              extended by atg.svc.ui.formhandlers.FrameworkBaseFormHandler
                                  extended by atg.svc.ui.formhandlers.SearchBaseFormHandler
                                      extended by atg.svc.ui.formhandlers.SearchFormHandler
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

public class SearchFormHandler
extends SearchBaseFormHandler

Performs search.


Field Summary
static java.lang.String AD_HOC_QUERY_ID
           
static java.lang.String CLASS_VERSION
          Class version string
static java.lang.String DEFAULT_SEARCH_PANEL
          Default search panel
static java.lang.String MAIN_SEARCH_INFO
           
protected  java.lang.String mFavoriteQueryId
           
protected  java.lang.String[] mFields
           
 boolean mFindDuplicatesSearch
           
protected  java.lang.String mPageNumber
           
protected  java.lang.String mQueryString
          Determines the page request Query String to be used in Self Service.
protected  java.lang.String mSolutionClass
           
static java.lang.String SEARCH_TEXT_INPUT_FIELDS
          Key for saving active constraints in window state
static java.lang.String SHOW_ADVANCED_EDITOR_WINDOW_STATE_KEY
          Key for saving advanced editor state in window state
static java.lang.String SHOW_RESEARCH_TOPIC_NAVIGATOR
          Key for saving focus topic display state in window state
static java.lang.String SHOW_TOPIC_NAVIGATOR
          Key for saving focus topic display state in window state
 
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
SearchFormHandler()
           
 
Method Summary
protected  java.lang.String[] convertStringToStringArray(java.lang.String[] pArray)
          convert a scaler to an array property
protected  void formHandlerInit(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
           
 java.lang.String getAdvancedSearchRightName()
          Returns the advancedSearchRightName.
 java.lang.String getFavoriteQueryId()
           
 java.lang.String[] getFields()
           
 java.lang.String getInitialSearchDelimiter()
          get InitialSearchDelimiter
 boolean getIsRecordSearch()
           
 java.lang.String getPageNumber()
           
 java.lang.String getQueryString()
           
 java.lang.String getSolutionClass()
           
 boolean handleDeleteSearchTextValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleFindSimilar(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
          Makes a pRequest to Search Server for values of the title and the fields specified to find similar solutions and pass search results through propert "searchResults".
 boolean handleInitialSearch(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
          handle an initial search
 boolean handlePageFirst(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handlePageLast(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handlePageNext(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handlePagePrevious(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handlePageWiseSearch(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handlePerformFindDuplicates(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
          Looks for duplicate solutions using a StructuredQueryRequest.
 boolean handlePerformFindSimilar(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
          Makes a pRequest to Search Server for values of the title and the fields specified to find similar solutions and pass search results through propert "searchResults".
 boolean handlePerformSearch(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handlePrevious(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleRefineTopic(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleResetSearch(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSaveActiveConstraints(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSaveCreationDate(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSaveFavoriteQuery(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSaveFormats(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSaveKeywords(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSaveLastModifiedDate(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSaveQueryLanguage(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSaveResultLanguage(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSaveTopics(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSearch(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleShowAdvancedEditor(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleSort(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleToggleResearchTopicNavigator(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
 boolean handleToggleTopicNavigator(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
protected  void initializeKnowledgeQueryContext(boolean pReplacePredicates)
           
 boolean isFindDuplicatesSearch()
           
 void page(int pStartIndex, int pPageSize)
           
protected  void parseInitialSearchParams()
          parse initial search params
 boolean performPageWiseSearch(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse response)
           
static void resetSearch()
           
 void saveKnowledgeQueryContext()
           
 void setAdvancedSearchRightName(java.lang.String pAdvancedSearchRightName)
          Sets the advancedSearchRightName.
 void setFavoriteQueryId(java.lang.String pFavoriteQueryId)
           
 void setFields(java.lang.String[] pFields)
           
 void setFindDuplicatesSearch(boolean pFindDuplicatesSearch)
           
 void setInitialSearchDelimiter(java.lang.String pInitialSearchDelimiter)
          set InitialSearchDelimiter
 void setIsRecordSearch(boolean pIsRecordSearch)
           
 void setPageNumber(java.lang.String pPageNumber)
           
 void setQueryString(java.lang.String pQueryString)
           
 void setSolutionClass(java.lang.String pSolutionClass)
           
 
Methods inherited from class atg.svc.ui.formhandlers.SearchBaseFormHandler
addDateCreatedMinPredicate, addDateModifiedMinPredicate, 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, 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


DEFAULT_SEARCH_PANEL

public static final java.lang.String DEFAULT_SEARCH_PANEL
Default search panel

See Also:
Constant Field Values

SEARCH_TEXT_INPUT_FIELDS

public static final java.lang.String SEARCH_TEXT_INPUT_FIELDS
Key for saving active constraints in window state

See Also:
Constant Field Values

SHOW_ADVANCED_EDITOR_WINDOW_STATE_KEY

public static final java.lang.String SHOW_ADVANCED_EDITOR_WINDOW_STATE_KEY
Key for saving advanced editor state in window state

See Also:
Constant Field Values

SHOW_RESEARCH_TOPIC_NAVIGATOR

public static final java.lang.String SHOW_RESEARCH_TOPIC_NAVIGATOR
Key for saving focus topic display state in window state

See Also:
Constant Field Values

SHOW_TOPIC_NAVIGATOR

public static final java.lang.String SHOW_TOPIC_NAVIGATOR
Key for saving focus topic display state in window state

See Also:
Constant Field Values

MAIN_SEARCH_INFO

public static final java.lang.String MAIN_SEARCH_INFO
See Also:
Constant Field Values

AD_HOC_QUERY_ID

public static final java.lang.String AD_HOC_QUERY_ID
See Also:
Constant Field Values

mFields

protected java.lang.String[] mFields

mSolutionClass

protected java.lang.String mSolutionClass

mFavoriteQueryId

protected java.lang.String mFavoriteQueryId

mFindDuplicatesSearch

public boolean mFindDuplicatesSearch

mPageNumber

protected java.lang.String mPageNumber

mQueryString

protected java.lang.String mQueryString
Determines the page request Query String to be used in Self Service. It will be used to construct results navigation links.

Constructor Detail

SearchFormHandler

public SearchFormHandler()
Method Detail

getIsRecordSearch

public boolean getIsRecordSearch()

setIsRecordSearch

public void setIsRecordSearch(boolean pIsRecordSearch)

getAdvancedSearchRightName

public java.lang.String getAdvancedSearchRightName()
Returns the advancedSearchRightName.

Returns:
advancedSearchRightName

setAdvancedSearchRightName

public void setAdvancedSearchRightName(java.lang.String pAdvancedSearchRightName)
Sets the advancedSearchRightName.

Parameters:
pAdvancedSearchRightName -

getFields

public java.lang.String[] getFields()

setFields

public void setFields(java.lang.String[] pFields)

getSolutionClass

public java.lang.String getSolutionClass()

setSolutionClass

public void setSolutionClass(java.lang.String pSolutionClass)

getFavoriteQueryId

public java.lang.String getFavoriteQueryId()

setFavoriteQueryId

public void setFavoriteQueryId(java.lang.String pFavoriteQueryId)

isFindDuplicatesSearch

public boolean isFindDuplicatesSearch()

setFindDuplicatesSearch

public void setFindDuplicatesSearch(boolean pFindDuplicatesSearch)

setPageNumber

public void setPageNumber(java.lang.String pPageNumber)

getPageNumber

public java.lang.String getPageNumber()

getQueryString

public java.lang.String getQueryString()

setQueryString

public void setQueryString(java.lang.String pQueryString)

setInitialSearchDelimiter

public void setInitialSearchDelimiter(java.lang.String pInitialSearchDelimiter)
set InitialSearchDelimiter

Parameters:
pInitialSearchDelimiter - the InitialSearchDelimiter

getInitialSearchDelimiter

public java.lang.String getInitialSearchDelimiter()
get InitialSearchDelimiter

Returns:
the InitialSearchDelimiter

page

public void page(int pStartIndex,
                 int pPageSize)
Specified by:
page in interface Pageable
Specified by:
page in class SearchBaseFormHandler

resetSearch

public static void resetSearch()

handleResetSearch

public boolean handleResetSearch(atg.servlet.DynamoHttpServletRequest pRequest,
                                 atg.servlet.DynamoHttpServletResponse response)
                          throws java.lang.Exception
Throws:
java.lang.Exception

handleShowAdvancedEditor

public boolean handleShowAdvancedEditor(atg.servlet.DynamoHttpServletRequest pRequest,
                                        atg.servlet.DynamoHttpServletResponse response)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

handleDeleteSearchTextValues

public boolean handleDeleteSearchTextValues(atg.servlet.DynamoHttpServletRequest pRequest,
                                            atg.servlet.DynamoHttpServletResponse response)
                                     throws java.lang.Exception
Throws:
java.lang.Exception

handlePrevious

public boolean handlePrevious(atg.servlet.DynamoHttpServletRequest pRequest,
                              atg.servlet.DynamoHttpServletResponse response)
                       throws java.lang.Exception
Throws:
java.lang.Exception

handlePageFirst

public boolean handlePageFirst(atg.servlet.DynamoHttpServletRequest pRequest,
                               atg.servlet.DynamoHttpServletResponse response)
                        throws java.lang.Exception
Throws:
java.lang.Exception

handlePagePrevious

public boolean handlePagePrevious(atg.servlet.DynamoHttpServletRequest pRequest,
                                  atg.servlet.DynamoHttpServletResponse response)
                           throws java.lang.Exception
Throws:
java.lang.Exception

handlePageNext

public boolean handlePageNext(atg.servlet.DynamoHttpServletRequest pRequest,
                              atg.servlet.DynamoHttpServletResponse response)
                       throws java.lang.Exception
Throws:
java.lang.Exception

handlePageLast

public boolean handlePageLast(atg.servlet.DynamoHttpServletRequest pRequest,
                              atg.servlet.DynamoHttpServletResponse response)
                       throws java.lang.Exception
Throws:
java.lang.Exception

handleSort

public boolean handleSort(atg.servlet.DynamoHttpServletRequest pRequest,
                          atg.servlet.DynamoHttpServletResponse response)
                   throws java.lang.Exception
Throws:
java.lang.Exception

handleRefineTopic

public boolean handleRefineTopic(atg.servlet.DynamoHttpServletRequest pRequest,
                                 atg.servlet.DynamoHttpServletResponse response)
                          throws java.lang.Exception
Throws:
java.lang.Exception

handlePerformSearch

public boolean handlePerformSearch(atg.servlet.DynamoHttpServletRequest pRequest,
                                   atg.servlet.DynamoHttpServletResponse response)
                            throws java.lang.Exception
Throws:
java.lang.Exception

handlePageWiseSearch

public boolean handlePageWiseSearch(atg.servlet.DynamoHttpServletRequest pRequest,
                                    atg.servlet.DynamoHttpServletResponse response)
                             throws java.lang.Exception
Throws:
java.lang.Exception

performPageWiseSearch

public boolean performPageWiseSearch(atg.servlet.DynamoHttpServletRequest pRequest,
                                     atg.servlet.DynamoHttpServletResponse response)
                              throws java.lang.Exception
Throws:
java.lang.Exception

handleSearch

public boolean handleSearch(atg.servlet.DynamoHttpServletRequest pRequest,
                            atg.servlet.DynamoHttpServletResponse response)
                     throws java.lang.Exception
Throws:
java.lang.Exception

handlePerformFindSimilar

public boolean handlePerformFindSimilar(atg.servlet.DynamoHttpServletRequest pRequest,
                                        atg.servlet.DynamoHttpServletResponse pResponse)
                                 throws java.lang.Exception
Makes a pRequest to Search Server for values of the title and the fields specified to find similar solutions and pass search results through propert "searchResults".

Throws:
java.lang.Exception

handleFindSimilar

public boolean handleFindSimilar(atg.servlet.DynamoHttpServletRequest pRequest,
                                 atg.servlet.DynamoHttpServletResponse pResponse)
                          throws java.lang.Exception
Makes a pRequest to Search Server for values of the title and the fields specified to find similar solutions and pass search results through propert "searchResults".

Throws:
java.lang.Exception

handlePerformFindDuplicates

public boolean handlePerformFindDuplicates(atg.servlet.DynamoHttpServletRequest pRequest,
                                           atg.servlet.DynamoHttpServletResponse pResponse)
                                    throws java.lang.Exception
Looks for duplicate solutions using a StructuredQueryRequest. Uses any statement, text or list properties in the input solution that are marked as 'Searchable' or as 'Both Searchable and Constrainable'. Each field value is a separate entry in the structured query request. Only solutions with the same solution class will match since text matches are only against values in the same field (e.g. question field matches question field, answer field matches answer field, etc). Search results are setin the "searchResults" property.

Throws:
java.lang.Exception

handleSaveActiveConstraints

public boolean handleSaveActiveConstraints(atg.servlet.DynamoHttpServletRequest pRequest,
                                           atg.servlet.DynamoHttpServletResponse response)
                                    throws java.lang.Exception
Throws:
java.lang.Exception

handleSaveCreationDate

public boolean handleSaveCreationDate(atg.servlet.DynamoHttpServletRequest pRequest,
                                      atg.servlet.DynamoHttpServletResponse response)
                               throws java.lang.Exception
Throws:
java.lang.Exception

handleSaveFormats

public boolean handleSaveFormats(atg.servlet.DynamoHttpServletRequest pRequest,
                                 atg.servlet.DynamoHttpServletResponse response)
                          throws java.lang.Exception
Throws:
java.lang.Exception

handleSaveKeywords

public boolean handleSaveKeywords(atg.servlet.DynamoHttpServletRequest pRequest,
                                  atg.servlet.DynamoHttpServletResponse response)
                           throws java.lang.Exception
Throws:
java.lang.Exception

handleSaveLastModifiedDate

public boolean handleSaveLastModifiedDate(atg.servlet.DynamoHttpServletRequest pRequest,
                                          atg.servlet.DynamoHttpServletResponse response)
                                   throws java.lang.Exception
Throws:
java.lang.Exception

handleSaveQueryLanguage

public boolean handleSaveQueryLanguage(atg.servlet.DynamoHttpServletRequest pRequest,
                                       atg.servlet.DynamoHttpServletResponse response)
                                throws java.lang.Exception
Throws:
java.lang.Exception

handleSaveResultLanguage

public boolean handleSaveResultLanguage(atg.servlet.DynamoHttpServletRequest pRequest,
                                        atg.servlet.DynamoHttpServletResponse response)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

handleSaveTopics

public boolean handleSaveTopics(atg.servlet.DynamoHttpServletRequest pRequest,
                                atg.servlet.DynamoHttpServletResponse response)
                         throws java.lang.Exception
Throws:
java.lang.Exception

handleSaveFavoriteQuery

public boolean handleSaveFavoriteQuery(atg.servlet.DynamoHttpServletRequest pRequest,
                                       atg.servlet.DynamoHttpServletResponse response)
                                throws java.lang.Exception
Throws:
java.lang.Exception

handleToggleTopicNavigator

public boolean handleToggleTopicNavigator(atg.servlet.DynamoHttpServletRequest pRequest,
                                          atg.servlet.DynamoHttpServletResponse response)
                                   throws java.lang.Exception
Throws:
java.lang.Exception

handleToggleResearchTopicNavigator

public boolean handleToggleResearchTopicNavigator(atg.servlet.DynamoHttpServletRequest pRequest,
                                                  atg.servlet.DynamoHttpServletResponse response)
                                           throws java.lang.Exception
Throws:
java.lang.Exception

formHandlerInit

protected void formHandlerInit(atg.servlet.DynamoHttpServletRequest pRequest,
                               atg.servlet.DynamoHttpServletResponse pResponse)
Overrides:
formHandlerInit in class SearchBaseFormHandler

saveKnowledgeQueryContext

public void saveKnowledgeQueryContext()

initializeKnowledgeQueryContext

protected void initializeKnowledgeQueryContext(boolean pReplacePredicates)
                                        throws ObjectNotFoundException
Overrides:
initializeKnowledgeQueryContext in class SearchBaseFormHandler
Throws:
ObjectNotFoundException

handleInitialSearch

public boolean handleInitialSearch(atg.servlet.DynamoHttpServletRequest pRequest,
                                   atg.servlet.DynamoHttpServletResponse pResponse)
                            throws java.lang.Exception
handle an initial search

Throws:
java.lang.Exception

parseInitialSearchParams

protected void parseInitialSearchParams()
parse initial search params


convertStringToStringArray

protected java.lang.String[] convertStringToStringArray(java.lang.String[] pArray)
convert a scaler to an array property