atg.commerce.csr.approvals
Class ApprovalRepositoryQueryFormHandler

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.search.PagingTableFormHandler
                                      atg.svc.search.RepositoryQueryTableFormHandler
                                          atg.commerce.csr.approvals.ApprovalRepositoryQueryFormHandler

All Implemented Interfaces:

atg.droplet.DropletFormHandler, atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, 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, atg.svc.ui.formhandlers.FormHandlerConstants, java.util.EventListener

public class ApprovalRepositoryQueryFormHandler
extends atg.svc.search.RepositoryQueryTableFormHandler

Form handler used to find any approvals of a given state and type. It extends RepositoryQueryTableFormHandler which will deal with the paging of results

Field Summary

static java.lang.String	CLASS_VERSION
protected ApprovalsManager	mApprovalsManager
protected java.lang.String[]	mApprovalStates
protected java.lang.String	mApprovalType

Fields inherited from class atg.svc.search.RepositoryQueryTableFormHandler

mItemDescriptorName, mRepository, mRepositoryView

Fields inherited from class atg.svc.search.PagingTableFormHandler

mCurrentPage, mResultsPerPage, mSearchResults, mSortDirection, mSortField, mTotalItemCount, SORT_DIRECTION_ASCENDING, SORT_DIRECTION_DESCENDING

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

ApprovalRepositoryQueryFormHandler()

Method Summary

protected atg.repository.Query	createSearchQuery(atg.repository.QueryBuilder pQueryBuilder) creates a query to search for approvals for given approval types and states.
ApprovalsManager	getApprovalsManager() Returns the approvals manager.
java.lang.String[]	getApprovalStates() Returns the approval states as an array of Strings.
java.lang.String	getApprovalType() Returns the approval type as a String.
protected atg.repository.RepositoryView	getRepositoryView() Returns the repository view for the configured repository and item descriptor name.
void	setApprovalsManager(ApprovalsManager pApprovalsManager) Sets the approvals manager.
void	setApprovalStates(java.lang.String[] pApprovalStates) Sets the approval states as an array of Strings.
void	setApprovalType(java.lang.String pApprovalType) Sets the approval type as a String.

Methods inherited from class atg.svc.search.RepositoryQueryTableFormHandler

assembleSearchResults, executeCountQuery, getItemDescriptorName, getRepository, search, setItemDescriptorName, setRepository

Methods inherited from class atg.svc.search.PagingTableFormHandler

buildSortDirectives, calculateEndIndex, calculateStartIndex, getCurrentPage, getResultsPerPage, getSearchResults, getSortDirection, getSortField, getTotalItemCount, handleSearch, postSearch, preSearch, setCurrentPage, setResultsPerPage, setSearchResults, setSortDirection, setSortField, setTotalItemCount

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

formHandlerInit, 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, getDefaultLocale, getRedirectDelayMS, getString, getString, getString, getSuccessURL, getUserLocale, getUserMessagesResourceBundle, handleCancel, isUseRequestLocale, processException, processException, processExceptionAndLog, processExceptionAndLog, redirect, setDefaultLocale, setRedirectDelayMS, setSuccessURL, setUseRequestLocale, 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, 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

See Also:

Constant Field Values

mApprovalsManager

protected ApprovalsManager mApprovalsManager

mApprovalType

protected java.lang.String mApprovalType

mApprovalStates

protected java.lang.String[] mApprovalStates

Constructor Detail

ApprovalRepositoryQueryFormHandler

public ApprovalRepositoryQueryFormHandler()

Method Detail

setApprovalsManager

public void setApprovalsManager(ApprovalsManager pApprovalsManager)

Sets the approvals manager.

Parameters:

pApprovalsManager - the ApprovalsManager to set

getApprovalsManager

public ApprovalsManager getApprovalsManager()

Returns the approvals manager.

Returns:

the ApprovalsManager

setApprovalType

public void setApprovalType(java.lang.String pApprovalType)

Sets the approval type as a String. This is used in the query. All approvals of a given type and state will be returned.

Parameters:

pApprovalType - the ApprovalType to set

getApprovalType

public java.lang.String getApprovalType()

Returns the approval type as a String. This is used in the query. All approvals of a given type and state will be returned.

Returns:

the ApprovalType

setApprovalStates

public void setApprovalStates(java.lang.String[] pApprovalStates)

Sets the approval states as an array of Strings. This is used in the query. All approvals of a given type and state will be returned.

Parameters:

pApprovalStates - the ApprovalStates to set

getApprovalStates

public java.lang.String[] getApprovalStates()

Returns the approval states as an array of Strings. This is used in the query. All approvals of a given type and state will be returned.

Returns:

the ApprovalStates

getRepositoryView

protected atg.repository.RepositoryView getRepositoryView()

Returns the repository view for the configured repository and item descriptor name.

Overrides:

getRepositoryView in class atg.svc.search.RepositoryQueryTableFormHandler

Returns:

RepositoryView

createSearchQuery

protected atg.repository.Query createSearchQuery(atg.repository.QueryBuilder pQueryBuilder)
                                          throws atg.repository.RepositoryException

creates a query to search for approvals for given approval types and states.

Specified by:

createSearchQuery in class atg.svc.search.RepositoryQueryTableFormHandler

Parameters:

pQueryBuilder - the QueryBuilder to set

Throws:

atg.repository.RepositoryException